Skip to content

Commit

Permalink
Document PR title requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
calumcalder committed Jan 6, 2025
1 parent b6e661e commit 8d7ff15
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,12 @@ that's welcome).

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose.

### PR Titles

To automate releases we require that PRs are titled according to
[conventional commits](https://conventionalcommits.org); i.e. that they
are tagged like `fix: handle exception XYZ correctly`, or
`feat: implement new video exporter`. See the conventional commits documentation
for more details.

0 comments on commit 8d7ff15

Please sign in to comment.