Skip to content

Commit dd96bde

Browse files
committed
doc: mention conventional commits
Signed-off-by: William Woodruff <[email protected]>
1 parent a75f253 commit dd96bde

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Thank you for your interest in contributing to `zizmor`!
55
This is intended to be a "high-level" guide with some suggestions
66
for ways to contribute. Once you've picked a contribution idea,
77
please see our [development docs]
8-
for concrete guidance on specific development tasks (such as building `zizmor`
9-
itself or the documentation website).
8+
for concrete guidance on specific development tasks and style prescriptions.
109

1110
## How to contribute
1211

docs/development.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ Here are some guidelines to follow if you're working on `zizmor`:
2222
behavior.
2323
* *Test on real inputs*. If you're contributing to or adding a new audit,
2424
make sure your analysis is reliable and accurate on non-sample inputs.
25+
* *Use [conventional commits]*. These are not mandatory, but they make
26+
it easier to quickly visually scan the contents of a change. Help us
27+
out by using them!
28+
29+
[conventional commits]: https://www.conventionalcommits.org/en/v1.0.0/
2530

2631
## Requirements
2732

0 commit comments

Comments
 (0)