mirrors/zizmor
1
0
Fork 0
mirror of https://github.com/zizmorcore/zizmor.git synced 2025-12-23 08:47:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

doc: mention conventional commits

Browse source 
Signed-off-by: William Woodruff <william@yossarian.net>
This commit is contained in:
William Woodruff 2024-11-01 10:13:15 -04:00
parent a75f253b62
commit dd96bde574
No known key found for this signature in database
2 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

3
CONTRIBUTING.md
View file

@ -5,8 +5,7 @@ Thank you for your interest in contributing to `zizmor`!
This is intended to be a "high-level" guide with some suggestions
for ways to contribute. Once you've picked a contribution idea,
please see our [development docs]
for concrete guidance on specific development tasks (such as building `zizmor`
itself or the documentation website).
for concrete guidance on specific development tasks and style prescriptions.
## How to contribute

5
docs/development.md
View file

@ -22,6 +22,11 @@ Here are some guidelines to follow if you're working on `zizmor`:
behavior.
* *Test on real inputs*. If you're contributing to or adding a new audit,
make sure your analysis is reliable and accurate on non-sample inputs.
* *Use [conventional commits]*. These are not mandatory, but they make
it easier to quickly visually scan the contents of a change. Help us
out by using them!
[conventional commits]: https://www.conventionalcommits.org/en/v1.0.0/
## Requirements