docs: add conventional commit guide and PR title examples #15638
Conversation
### 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 change aims to help new contributors understand how to format commit messages and pull request titles effectively, improving changelog automation and project consistency.
github-actions
bot
added
the
documentation
|
Hi @alamb @fintelia @zebsme ! |
| - `feat: add support for XYZ operator` | ||
| - `chore: update Cargo dependencies` | ||
|
|
||
| Using these formats helps: |
There was a problem hiding this 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
|
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 |
|
Converting to draft as th CI checks are failing and I think this PR is no longer waiting for feedback |
Summary
Added a new section under Conventional Commits & Labeling PRs that provides:
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?
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.