Skip to content

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.

  1. Apache-2.0 license
    • license plates in each file as SPDX ids
    • license file
    • Cargo.toml license
  2. MSRV
    • Cargo.toml edition & rust-version
    • rust-toolchain.toml
    • MSRV CI
  3. Info
    • README.md
    • CONTRIBUTING.md
    • CHANGELOG.md
    • CODE_OF_CONDUCT.md
  4. Crate info
    • correct homepage & repo URL
    • correct keywords
    • correct categories
    • correct author(s) email
    • correct description
  5. Formatting
    • .rustfmt.toml
  6. CI
    • Badges in README
    • Makefile.toml
    • CI scripts based on makefile
    • correct features for CI
    • contrib/depCargo.toml and as-dependency build
  7. Sponsors: in .githum/FUNDING.yml
    • author(s)
    • organization(s)
  8. Docs:
    • add

      [package.metadata.docs.rs]
      all-features = true
      rustc-args = ["--cfg", "docsrs"]
      
    • add feature gates with docsrs

  9. Security
    • Enable Security reporting
    • Add SECURITY.md
  10. Test coverage
    • Ensure CI is running and reported
    • Edit codecov.yml and set proper test coverage targets
Clone this wiki locally