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

[MISC] Enforce commit message format #11

Open
dksifoua opened this issue Sep 3, 2022 · 0 comments
Open

[MISC] Enforce commit message format #11

dksifoua opened this issue Sep 3, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@dksifoua
Copy link
Owner

dksifoua commented Sep 3, 2022

Setup a git commit message convention

The commit message should be structured as follows:

<type>(<optional scope>): <subject>
<optional body>
<optional footer>

Types

  • feat: Commits, that adds a new feature
  • fix: Commits, that fixes a bug
  • refactor: Commits, that rewrite/restructure your code, however does not change any behaviour
  • perf: Commits are special special refactor commits, that improve performance
  • style: Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
  • tests: Commits, that add missing tests or correcting existing tests
  • docs: Commits, that affect documentation only
  • build: Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ...
  • Ops: Commits, that affect operational components like infrastructure, deployment, backup, recovery, ...
  • chore: Miscellaneous commits e.g. modifying .gitignore
@dksifoua dksifoua added the enhancement New feature or request label Sep 3, 2022
@dksifoua dksifoua linked a pull request Sep 9, 2022 that will close this issue
@dksifoua dksifoua removed a link to a pull request Sep 9, 2022
@dksifoua dksifoua self-assigned this Sep 20, 2022
@dksifoua dksifoua changed the title Enforce commit message format [MISC] Enforce commit message format Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant