From e17f03e7555b7b6f5348b9854f3d4ef559e84d75 Mon Sep 17 00:00:00 2001 From: Steve Myers Date: Wed, 19 Jul 2023 16:15:35 -0500 Subject: [PATCH] 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/. --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20063604d..ad3d7fdbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,15 +46,15 @@ Every new feature should be covered by functional tests where possible. When refactoring, structure your PR to make it easy to review and don't hesitate to split it into multiple small, focused PRs. -The Minimal Supported Rust Version is 1.46 (enforced by our CI). +The Minimal Supported Rust Version is **1.57.0** (enforced by our CI). Commits should cover both the issue fixed and the solution's rationale. -These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind. +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. To facilitate communication with other contributors, the project is making use of GitHub's "assignee" field. First check that no one is assigned and then comment suggesting that you're working on it. If someone is already assigned, -don't hesitate to ask if the assigned party or previous commenters are still +don't hesitate to ask if the assigned party or previous commenter are still working on it if it has been awhile. Deprecation policy