-
-
Notifications
You must be signed in to change notification settings - Fork 8
Housekeeping
Dr. Maxim Orlovsky edited this page Dec 28, 2022
·
5 revisions
This defines what each repo and crate must have as a part of their files.
- Apache-2.0 license
- license plates in each file as SPDX ids
- license file
- Cargo.toml license
- MSRV
- Cargo.toml edition & rust-version
- rust-toolchain.toml
- MSRV CI
- Info
- README.md
- CONTRIBUTING.md
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- Crate info
- correct homepage & repo URL
- correct keywords
- correct categories
- correct author(s) email
- correct description
- Formatting
- .rustfmt.toml
- CI
- Badges in README
- Makefile.toml
- CI scripts based on makefile
- correct features for CI
-
contrib/depCargo.toml
and as-dependency build
- Sponsors: in
.githum/FUNDING.yml
- author(s)
- organization(s)
- Docs:
-
add
[package.metadata.docs.rs] all-features = true rustc-args = ["--cfg", "docsrs"]
-
add feature gates with docsrs
-
- Security
- Enable Security reporting
- Add SECURITY.md
- Test coverage
- Ensure CI is running and reported
- Edit codecov.yml and set proper test coverage targets