diff options
author | juga <juga@sequoia-pgp.org> | 2019-06-14 14:00:07 +0000 |
---|---|---|
committer | juga <juga@sequoia-pgp.org> | 2019-06-14 14:14:18 +0000 |
commit | 25e7c8a7d04aad5b71df25fcf1cad25c8280ffa6 (patch) | |
tree | efb3239bc8aae8ce715394e1f9dcad32d1a32180 | |
parent | ca632193a047fddf2662f5a7113ef102158b8ab4 (diff) |
doc: Add sections about workflowcoding-conventions
-rw-r--r-- | doc/coding-conventions.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/coding-conventions.md b/doc/coding-conventions.md index 179996fc..5b5ebd1b 100644 --- a/doc/coding-conventions.md +++ b/doc/coding-conventions.md @@ -72,5 +72,24 @@ in the code and documentation. | Key ID | keyid | keyid, id | keyid | Key ID | | User ID | userid | userid, uid | userid | User ID | +## Commits + +- The first word should be the name of the crate, followed by colon. +- The description is indented 2 spaces. +- In general, follow [A Note About Git Commit Messages]. + +## Merge requests + +- During review, there is no need for fixups, you can squash and push force, + though some of us prefer fixups and only squash them when the MR is ready + to merge. +- You can merge your own MR when not modifying someone else code, except + someone new to the project. + +## Releases + +TBD + [clearer traits]: https://doc.rust-lang.org/stable/book/ch10-02-traits.html#clearer-trait-bounds-with-where-clauses [Rust Style Guide]: https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md +[A Note About Git Commit Messages]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |