You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Merge #1039: docs: add required style for commit messages
e17f03e docs: add required style for commit messages (Steve Myers)
Pull request description:
### Description
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/. I also fixed our current MSRV in the doc and fixed a spelling error.
### Notes to the reviewers
I'm open to suggestions if anyone has another well documented style for commit messages.
### Changelog notice
None.
### Checklists
#### All Submissions:
* [x] I've signed all my commits
* [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
* [x] I ran `cargo fmt` and `cargo clippy` before committing
ACKs for top commit:
thunderbiscuit:
ACK e17f03e. I've been using conventional commits for Padawan for over 2 years and think it's got good value, particularly on projects with bigger teams and number of contributors.
danielabrozzoni:
ACK e17f03e - I was hesitant at first, but I think this would make the commit messages cleaner (and in most cases even shorter). Going forward we should consider adding a CI check enforcing this.
Tree-SHA512: 5f4c42814e35e013ff7846110b2897a35720b8f4b8974f8c8004fc0f5161a10076cac62a7aa711c14295129999f93e238034972f28b77145c1917613f8856b03
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,15 +46,15 @@ Every new feature should be covered by functional tests where possible.
46
46
When refactoring, structure your PR to make it easy to review and don't
47
47
hesitate to split it into multiple small, focused PRs.
48
48
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).
50
50
51
51
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.
53
53
54
54
To facilitate communication with other contributors, the project is making use
55
55
of GitHub's "assignee" field. First check that no one is assigned and then
56
56
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
0 commit comments