Skip to content

Commit fb2dc97

Browse files
authored
readme: update commit message guidelines (#6393)
1 parent a3d2548 commit fb2dc97

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

CONTRIBUTING.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -368,14 +368,16 @@ A good commit message should describe what changed and why.
368368
and no more than 72 characters)
369369
* be entirely in lowercase with the exception of proper nouns, acronyms, and
370370
the words that refer to code, like function/variable names
371-
* be prefixed with the name of the sub crate being changed (without the `tokio-`
372-
prefix) and start with an imperative verb. If modifying `tokio` proper,
373-
omit the crate prefix.
371+
* start with an imperative verb
372+
* not have a period at the end
373+
* be prefixed with the name of the module being changed; usually this is the
374+
same as the M-* label on the PR
374375
375376
Examples:
376377
377-
* timer: introduce `Timeout` and deprecate `Deadline`
378-
* export `Encoder`, `Decoder`, `Framed*` from tokio_codec
378+
* time: introduce `Timeout` and deprecate `Deadline`
379+
* codec: export `Encoder`, `Decoder`, `Framed*`
380+
* ci: fix the FreeBSD ci configuration
379381
380382
2. Keep the second line blank.
381383
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.
392394
Sample complete commit message:
393395
394396
```txt
395-
subcrate: explain the commit in one line
397+
module: explain the commit in one line
396398
397399
Body of commit message is a few lines of text, explaining things
398400
in more detail, possibly giving some background about the issue

0 commit comments

Comments
 (0)