Skip to content

minor: create convention commit syntax#19089

Open
jtuglu1 wants to merge 1 commit intoapache:masterfrom
jtuglu1:conventional-commits
Open

minor: create convention commit syntax#19089
jtuglu1 wants to merge 1 commit intoapache:masterfrom
jtuglu1:conventional-commits

Conversation

@jtuglu1
Copy link
Contributor

@jtuglu1 jtuglu1 commented Mar 5, 2026

Description

Something I've seen many large open source projects adopt:

  1. Conventional commit syntax (easier to auto-generate release notes, bisect for issues, etc. as it requires more context to be stored in the commits themselves, and not the PR/issue).

Release note

Enforce conventional commit format. This will also help making debugging issues, etc. as in addition to GH tags (something not persisted in the git lineage) breaking changes/bug fixes/feature information is recorded in the git tree.


This PR has:

  • been self-reviewed.
  • added documentation for new or modified features or behaviors.
  • a release note entry in the PR description.
  • added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
  • added or updated version, license, or notice information in licenses.yaml
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added unit tests or modified existing tests to cover new code paths, ensuring the threshold for code coverage is met.
  • added integration tests.
  • been tested in a test Druid cluster.

@jtuglu1 jtuglu1 force-pushed the conventional-commits branch from 3cbe4a6 to 918b140 Compare March 14, 2026 03:15
@jtuglu1 jtuglu1 changed the title chore: create convention commit syntax and ensure poms are sorted minor: create convention commit syntax and ensure poms are sorted Mar 14, 2026
@jtuglu1
Copy link
Contributor Author

jtuglu1 commented Mar 14, 2026

@gianm updated. I think we should also make the default repo settings on PRs to do a merge and take the PR description (e.g. not just force a *-list of commit messages (which often aren't descriptive at all).

@jtuglu1 jtuglu1 requested a review from gianm March 14, 2026 03:18
@jtuglu1 jtuglu1 marked this pull request as ready for review March 14, 2026 03:18
@jtuglu1 jtuglu1 changed the title minor: create convention commit syntax and ensure poms are sorted minor: create convention commit syntax Mar 14, 2026
@jtuglu1 jtuglu1 force-pushed the conventional-commits branch from 918b140 to bab78f4 Compare March 14, 2026 04:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants