From fb2dc97468fead3c1d318f209a65648e11ade55d Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Tue, 12 Mar 2024 15:21:08 +0100 Subject: [PATCH] readme: update commit message guidelines (#6393) --- CONTRIBUTING.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e9bb2c99..623efd133 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -368,14 +368,16 @@ A good commit message should describe what changed and why. and no more than 72 characters) * be entirely in lowercase with the exception of proper nouns, acronyms, and the words that refer to code, like function/variable names - * be prefixed with the name of the sub crate being changed (without the `tokio-` - prefix) and start with an imperative verb. If modifying `tokio` proper, - omit the crate prefix. + * start with an imperative verb + * not have a period at the end + * be prefixed with the name of the module being changed; usually this is the + same as the M-* label on the PR Examples: - * timer: introduce `Timeout` and deprecate `Deadline` - * export `Encoder`, `Decoder`, `Framed*` from tokio_codec + * time: introduce `Timeout` and deprecate `Deadline` + * codec: export `Encoder`, `Decoder`, `Framed*` + * ci: fix the FreeBSD ci configuration 2. Keep the second line blank. 3. Wrap all other lines at 72 columns (except for long URLs). @@ -392,7 +394,7 @@ A good commit message should describe what changed and why. Sample complete commit message: ```txt -subcrate: explain the commit in one line +module: explain the commit in one line Body of commit message is a few lines of text, explaining things in more detail, possibly giving some background about the issue