Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document and settle on a commit message convention #1381

Open
proppy opened this issue Apr 16, 2024 · 0 comments
Open

Document and settle on a commit message convention #1381

proppy opened this issue Apr 16, 2024 · 0 comments
Labels
build Related to build flow, build system, or build macros cleanup Tech debt reduction, factoring, consolidation, rework, etc. documentation Improvements or additions to documentation

Comments

@proppy
Copy link
Member

proppy commented Apr 16, 2024

Currently it seems that we use different conventions for public commit messages in this repository:

  • @cdleary tend to use [Subsystem:Sub subsystem][downcase(Type of change)] Message
  • @proppy tend to use subdirectory: message
  • other contributors tend to use Message

In general Message start with an action verb like Add, Fix, Update or Improve.

It would be nice to settle on a unified convention like @cdleary's or re-use well established one like https://www.conventionalcommits.org/.

That would also help w/ things like #1380 and can also be enforced with pre-submit github actions.

@proppy proppy added build Related to build flow, build system, or build macros cleanup Tech debt reduction, factoring, consolidation, rework, etc. documentation Improvements or additions to documentation labels Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Related to build flow, build system, or build macros cleanup Tech debt reduction, factoring, consolidation, rework, etc. documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant