Skip to content

Commit

Permalink
doc: mention conventional commits
Browse files Browse the repository at this point in the history
Signed-off-by: William Woodruff <[email protected]>
  • Loading branch information
woodruffw committed Nov 1, 2024
1 parent a75f253 commit dd96bde
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit dd96bde

Please sign in to comment.