afiqzudinhadi/TagStudio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: refer to conventional commits in CONTRIBUTING.md

Browse source 
Co-Authored-By: Xarvex <60973030+xarvex@users.noreply.github.com>
This commit is contained in:
Travis Abendshien 2024-09-12 15:58:08 -07:00
parent 2f2f763a29
commit a8fdae8ebc
1 changed files with 2 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -154,11 +154,9 @@ Most of the style guidelines can be checked, fixed, and enforced via Ruff. Older
#### Git/GitHub Specifics
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) is used as a guideline for commit messages. This allows us to easily generate changelogs for releases.
- See some [examples](https://www.conventionalcommits.org/en/v1.0.0/#examples) of what this looks like in practice.
- Use clear and concise commit messages. If your commit does too much, either consider breaking it up into smaller commits or providing extra detail in the commit description.
- Use imperative-style present-tense commit messages. Examples:
- "Add feature foo"
- "Change method bar"
- "Fix function foobar"
- Pull Requests should have an adequate title and description which clearly outline your intentions and changes/additions. Feel free to provide screenshots, GIFs, or videos, especially for UI changes.
## Documentation Guidelines