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-unsubscr...@datafusion.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For additional commands, e-mail: github-h...@datafusion.apache.org
