Skip to content

Commit a475361

Browse files
committed
Contributing: add "Submit checklist addendum" and "Key cycle dates" subsections
These come from the "Maintainer Entry Profile" template. Signed-off-by: Miguel Ojeda <[email protected]>
1 parent 023b2af commit a475361

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

src/Contributing.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,30 @@ For new abstractions and modules, and especially for those that require new kern
9090

9191
Please contact the Rust maintainers for help, especially if you find yourself with a lot of dependencies or patches for unrelated subsystems.
9292

93+
### Submit checklist addendum
94+
95+
- Please run your patch through the `scripts/checkpatch.pl` script. In particular, the `--codespell` option is useful to check patches for typos.
96+
97+
- Please format the code by running the `rustfmt` target.
98+
99+
- Please keep the code Clippy-clean by compiling with `CLIPPY=1`.
100+
101+
- When submitting changes to Rust code documentation, please render them using the `rustdoc` target and ensure the result looks as expected.
102+
103+
- When submitting changes to examples inside Rust code documentation (i.e. "doctests"), which are transformed into KUnit tests, please test them by [running them](https://docs.kernel.org/rust/general-information.html#testing).
104+
105+
- When submitting changes to the Rust folder of the kernel documentation (i.e. `Documentation/rust/`), which are written in reStructuredText and handled by Sphinx, please [render them](https://docs.kernel.org/doc-guide/sphinx.html) (typically using the `htmldocs` target) to ensure there are no warnings and that the result looks as expected.
106+
107+
- When submitting changes to `#[test]`s, please test them by running the `rusttest` target.
108+
109+
### Key cycle dates
110+
111+
- Patches can be sent anytime.
112+
113+
- We aim to send early PRs to Linus, to have patches for at least a week in linux-next and to give patches at least a week of review time.
114+
115+
Therefore, in general, the last version of a patch series with new features (i.e. aimed at the next merge window) should arrive before -rc5.
116+
93117
## Submitting patches
94118

95119
If you are using a CLI tool like [`git-send-email`](https://git-scm.com/docs/git-send-email) or [`b4`](https://b4.docs.kernel.org), then you may find the following commands useful for generating the options needed for submitting patches to the Rust subsystem:

0 commit comments

Comments
 (0)