itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-10-01 12:20:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme: update commit message guidelines (#6393)

Browse Source
This commit is contained in:
Alice Ryhl 2024-03-12 15:21:08 +01:00 committed by GitHub
parent a3d2548789
commit fb2dc97468
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -368,14 +368,16 @@ A good commit message should describe what changed and why.
and no more than 72 characters) and no more than 72 characters)
* be entirely in lowercase with the exception of proper nouns, acronyms, and * be entirely in lowercase with the exception of proper nouns, acronyms, and
the words that refer to code, like function/variable names the words that refer to code, like function/variable names
* be prefixed with the name of the sub crate being changed (without the `tokio-` * start with an imperative verb
prefix) and start with an imperative verb. If modifying `tokio` proper, * not have a period at the end
omit the crate prefix. * be prefixed with the name of the module being changed; usually this is the
same as the M-* label on the PR
Examples: Examples:
* timer: introduce `Timeout` and deprecate `Deadline` * time: introduce `Timeout` and deprecate `Deadline`
* export `Encoder`, `Decoder`, `Framed*` from tokio_codec * codec: export `Encoder`, `Decoder`, `Framed*`
* ci: fix the FreeBSD ci configuration
2. Keep the second line blank. 2. Keep the second line blank.
3. Wrap all other lines at 72 columns (except for long URLs). 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: Sample complete commit message:
```txt ```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 Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue in more detail, possibly giving some background about the issue