You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "THEAYUSHIMISHRA (via GitHub)" <gi...@apache.org> on 2025/04/08 14:56:27 UTC
[PR] docs: add conventional commit guide and PR title examples [datafusion]
THEAYUSHIMISHRA opened a new pull request, #15638:
URL: https://github.com/apache/datafusion/pull/15638
### Summary
Added a new section under **Conventional Commits & Labeling PRs** that provides:
- A table of common commit prefixes and their purposes
- Example PR titles for clarity
- A link to the official Conventional Commits specification
### Purpose
This addition is intended to assist new contributors in formatting their commit messages and PR titles effectively. It helps maintain consistency, improves changelog automation, and aligns with the contribution guidelines.
## Which issue does this PR close?
- Closes #14886
## Rationale for this change
This change enhances contributor experience by providing clear, practical examples and formatting guidance. It supports the maintainers’ existing structure and promotes better practices for contribution labeling.
## What changes are included in this PR?
1)Added a commit prefix table
2)Included example PR titles
3)Added a helpful external reference link
## Are these changes tested?
As this is a documentation update, testing is not applicable.
## Are there any user-facing changes?
Yes, this improves the documentation for all contributors, particularly newcomers. No functional changes are made to the project.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: add conventional commit guide and PR title examples [datafusion]
Posted by "berkaysynnada (via GitHub)" <gi...@apache.org>.
berkaysynnada commented on code in PR #15638:
URL: https://github.com/apache/datafusion/pull/15638#discussion_r2034771722
##########
docs/source/contributor-guide/index.md:
##########
@@ -156,6 +156,29 @@ convention but encourage its use if you want your PR to feature in the correct s
The change log generator will also look at GitHub labels such as `bug`, `enhancement`, or `api change`, and labels
do take priority over the conventional commit approach, allowing maintainers to re-categorize PRs after they have been merged.
+#### Commit Prefix Guide
+
+| Prefix | Purpose |
+|------------|-----------------------------------------|
+| `feat:` | A new feature |
+| `fix:` | A bug fix |
+| `docs:` | Documentation only changes |
+| `chore:` | Build process or auxiliary tool changes |
+| `refactor:`| Code changes that neither fix nor add |
Review Comment:
what was the difference between chore and refactor?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: add conventional commit guide and PR title examples [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #15638:
URL: https://github.com/apache/datafusion/pull/15638#issuecomment-2794846450
Thank you for this proposal @THEAYUSHIMISHRA
I think for a PR such as this, we should get some agreement or try and summarize what *currently* happens in DataFusion rather than trying to change what happens *in the future* with documentation
I fear if we merge this PR it will just add to confusion as most PRs will not conform to the suggestions and thus people will wonder about the rest of the docs when they see stuff in there that is clearly not followed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: add conventional commit guide and PR title examples [datafusion]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #15638: docs: add conventional commit guide and PR title examples
URL: https://github.com/apache/datafusion/pull/15638
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: add conventional commit guide and PR title examples [datafusion]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #15638:
URL: https://github.com/apache/datafusion/pull/15638#issuecomment-2961018128
Thank you for your contribution. Unfortunately, this pull request is stale because it has been open 60 days with no activity. Please remove the stale label or comment or this will be closed in 7 days.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: add conventional commit guide and PR title examples [datafusion]
Posted by "THEAYUSHIMISHRA (via GitHub)" <gi...@apache.org>.
THEAYUSHIMISHRA commented on PR #15638:
URL: https://github.com/apache/datafusion/pull/15638#issuecomment-2786775094
Hi @alamb @fintelia @zebsme !
I’ve submitted a small documentation update that addresses #14886, aiming to improve clarity for new contributors on conventional commit formats.
Whenever you or *any available reviewer* gets a moment, I’d truly appreciate your feedback or suggestions. Thanks a lot for your time and for maintaining such a great project!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: add conventional commit guide and PR title examples [datafusion]
Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #15638:
URL: https://github.com/apache/datafusion/pull/15638#discussion_r2033542901
##########
docs/source/contributor-guide/index.md:
##########
@@ -156,6 +156,29 @@ convention but encourage its use if you want your PR to feature in the correct s
The change log generator will also look at GitHub labels such as `bug`, `enhancement`, or `api change`, and labels
do take priority over the conventional commit approach, allowing maintainers to re-categorize PRs after they have been merged.
+#### Commit Prefix Guide
+
+| Prefix | Purpose |
+|------------|-----------------------------------------|
+| `feat:` | A new feature |
+| `fix:` | A bug fix |
+| `docs:` | Documentation only changes |
+| `chore:` | Build process or auxiliary tool changes |
+| `refactor:`| Code changes that neither fix nor add |
+| `test:` | Adding or updating tests |
+
+#### Example PR Titles
+
+- `docs: update README with example usage`
+- `fix: resolve crash on null input`
+- `feat: add support for XYZ operator`
+- `chore: update Cargo dependencies`
+
+Using these formats helps:
Review Comment:
I was thinking on github labels actually solves the problem to identify the PR flavor but changelog sounds reasonable. But just having prefixes is not enough, we need to have PR title checker like we did in Comet https://github.com/apache/datafusion-comet/blob/main/.github/workflows/pr_title_check.yml
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: add conventional commit guide and PR title examples [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #15638:
URL: https://github.com/apache/datafusion/pull/15638#issuecomment-2794847709
Converting to draft as th CI checks are failing and I think this PR is no longer waiting for feedback
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: add conventional commit guide and PR title examples [datafusion]
Posted by "berkaysynnada (via GitHub)" <gi...@apache.org>.
berkaysynnada commented on code in PR #15638:
URL: https://github.com/apache/datafusion/pull/15638#discussion_r2034771193
##########
docs/source/contributor-guide/index.md:
##########
@@ -156,6 +156,29 @@ convention but encourage its use if you want your PR to feature in the correct s
The change log generator will also look at GitHub labels such as `bug`, `enhancement`, or `api change`, and labels
do take priority over the conventional commit approach, allowing maintainers to re-categorize PRs after they have been merged.
+#### Commit Prefix Guide
+
+| Prefix | Purpose |
+|------------|-----------------------------------------|
+| `feat:` | A new feature |
+| `fix:` | A bug fix |
+| `docs:` | Documentation only changes |
+| `chore:` | Build process or auxiliary tool changes |
+| `refactor:`| Code changes that neither fix nor add |
Review Comment:
what was the difference between chore and refactor?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org