Skip to content

Commit

Permalink
docs: request that pr titles resemble a conventional commit (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
zimeg authored Feb 18, 2024
1 parent fd3558b commit 85d091e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
8 changes: 5 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ additional checks before opening a pull request:
Once this looks good to you, [create a pull request][fork_pr] with the following
information:

- A title that summarizes the goal of the changes
- A title that summarizes the goal of the changes, formatted as a
[conventional commit][commit]
- A summary of the changes and any notes, as needed

And with that, you can open the pull request and wait for a review! Woo! Go you!
Expand All @@ -67,9 +68,10 @@ For more information on the code processes for this project, check out the
[`MAINTAINERS_GUIDE.md`][maintainers].

<!-- a collection of links -->
[commit]: https://www.conventionalcommits.org/en/v1.0.0/
[conduct]: ./CODE_OF_CONDUCT.md
[issues]: https://github.com/zimeg/emporia-time/issues
[security]: https://github.com/zimeg/emporia-time/security
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository
[fork_pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
[issues]: https://github.com/zimeg/emporia-time/issues
[maintainers]: ./MAINTAINERS_GUIDE.md
[security]: https://github.com/zimeg/emporia-time/security
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Automatically extend the license at the start of a year
- Use the development Nix flake in continuous integration
- Checkout the entire Git history for automated testing
- Request that PR titles resemble a conventional commit

## [0.1.1] - 2024-01-15

Expand Down

0 comments on commit 85d091e

Please sign in to comment.