Use this checklist to update an existing repository so it matches the structure and policies of the `NethermindEth/rust-template` template. ### Replace template placeholders - [ ] Find and remove all `TODO(template)` markers throughout the repo - [ ] Update `README.md`: - Replace placeholder name/description - Remove any template guidance sections - [ ] Review and adjust `LICENSE` files ### Repository configuration - [x] Add relevant teams/collaborators (e.g., your engineering group) with admin permissions - [x] Pull requests: enable **Squash merging** and **Auto-delete branch after merge** - [ ] Update repository-level metadata: - Description, topics/tags, website or docs link - [ ] (If applicable) Enable GitHub Pages and link it in project docs ### Branch protection & security - [x] [Protect](https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/build-and-test.yml) `main` branch: - [x] Enforce [signed commits](https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/build-and-test.yml) on **all** branches - [ ] Verify `SECURITY.md` is present and up‑to‑date ### CI / Tooling / Code standards - [ ] CI workflows run on **push** and **PR** (build, test, lint) - [build-and-test](https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/build-and-test.yml) - [dependency-audit](https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/dependency-audit.yml) - [docs](https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/docs.yml) - [linter](https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/linter.yml) - [ub-detection](https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/ub-detection.yml) - [coverage](https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/coverage.yml) - [ ] Ensure config files exist and reflect CI needs: - `rust-toolchain.toml` - `rustfmt.toml` - `deny.toml` - [ ] Add additional CI actions if needed: - Coverage report, benchmarks, artifact publishing ### Contribution & ownership - [ ] Update `CODEOWNERS` and `CONTRIBUTING.md` to reflect your team - [ ] Add clear signing/review/contribution guidance - [ ] Credit all existing contributors in docs or README ### Release & publishing - [ ] Configure crate publishing if applicable (`Cargo.toml`, access tokens, etc.) - [ ] Include a release workflow or tag template - [ ] Set up changelog guidelines (e.g., conventional commits, keepachangelog)
Use this checklist to update an existing repository so it matches the structure and policies of the
NethermindEth/rust-templatetemplate.Replace template placeholders
TODO(template)markers throughout the repoREADME.md:LICENSEfilesRepository configuration
Branch protection & security
mainbranch:SECURITY.mdis present and up‑to‑dateCI / Tooling / Code standards
rust-toolchain.tomlrustfmt.tomldeny.tomlContribution & ownership
CODEOWNERSandCONTRIBUTING.mdto reflect your teamRelease & publishing
Cargo.toml, access tokens, etc.)