Skip to content

Commit e17f03e

Browse files
committed
docs: add required style for commit messages
Update CONTRIBUTING.md to specify that new commits should use 'Conventional Commits 1.0' style messages. See https://www.conventionalcommits.org/en/v1.0.0/.
1 parent f4d2a76 commit e17f03e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ Every new feature should be covered by functional tests where possible.
4646
When refactoring, structure your PR to make it easy to review and don't
4747
hesitate to split it into multiple small, focused PRs.
4848

49-
The Minimal Supported Rust Version is 1.46 (enforced by our CI).
49+
The Minimal Supported Rust Version is **1.57.0** (enforced by our CI).
5050

5151
Commits should cover both the issue fixed and the solution's rationale.
52-
These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
52+
These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind. Commit messages should follow the ["Conventional Commits 1.0.0"](https://www.conventionalcommits.org/en/v1.0.0/) to make commit histories easier to read by humans and automated tools.
5353

5454
To facilitate communication with other contributors, the project is making use
5555
of GitHub's "assignee" field. First check that no one is assigned and then
5656
comment suggesting that you're working on it. If someone is already assigned,
57-
don't hesitate to ask if the assigned party or previous commenters are still
57+
don't hesitate to ask if the assigned party or previous commenter are still
5858
working on it if it has been awhile.
5959

6060
Deprecation policy

0 commit comments

Comments
 (0)