github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-28 20:41:04 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #279 from bookinabox/remove-checkcommits-from-documentation

Browse Source 
contributing: remove checkommit mentions+update body docs
This commit is contained in:
Chelsea Mafrica 2022-08-04 15:13:44 -07:00 committed by GitHub
commit 319fa21cf8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -92,7 +92,7 @@ Prerequisites.
### Rustlang coding style
* Use `rustfmt` to fix any mechanical style issues. Rustfmt uses a style which conforms to the
* Use `rustfmt` to fix any mechanical style issues. `Rustfmt` uses a style which conforms to the
[Rust Style Guide](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md).
* Use `clippy` to catch common mistakes and improve your Rust code.
@ -811,12 +811,23 @@ As shown above, pull requests must adhere to these guidelines:
* Ensure PR title length is 75 characters or fewer, including whichever
`subsystem` term is used.
* Ensure the PR body line length is 72 characters or fewer.
* Ensure the PR body line length is 150 characters or fewer.
The body of the message is **not** a continuation of the subject line and is
not used to extend the subject line beyond its character limit. The subject
line is a complete sentence and the body is a complete, standalone paragraph.
Additionally, PR body line length is not checked for special lines:
* Lines that do not start with an alphabetic character
* Sign-off lines (as to not penalize long names)
* Lines without spaces
These should allow contributors to pass checks while including relevant
information **if needed**.
### Subsystem
The "subsystem" describes the area of the code that the change applies to.
@ -859,9 +870,7 @@ is also acceptable to include additional or
### Verification
Correct formatting of the PR patches is verified using the
[`checkcommits`](https://github.com/kata-containers/tests/tree/master/cmd/checkcommits)
tool.
Correct formatting of the PR patches is verified using the commit-message-check GitHub Action.
### Examples