Skip to content

Commit

Permalink
docs: Explain how commit messages should be formatted (#94)
Browse files Browse the repository at this point in the history
  • Loading branch information
gteufelberger authored Jun 28, 2024
1 parent 5316778 commit 3563188
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ To get the procedures, go to the [release page on right side](https://github.com

Commit messages should follow [conventional commit message structure](https://www.conventionalcommits.org/)

TODO: examples
**Exempt from this are commits that only change procedure contents.**

This means, if your commit edits anything other than procedure contents, then you should prefix your commit messages with for example
- `feat:` for changes that are not procedure related, e.g. adding a new LaTeX skeleton or
- `fix:` for all other changes
- `docs:` for documentation changes regarding the repo like updating the readme or comments in the LaTeX source.
- `refactor:` for changes in the LaTeX structure like renaming a file or moving imports

Changes should be small and atomic.
Basically make many small PRs rather than one big one.
Expand Down

0 comments on commit 3563188

Please sign in to comment.