-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Description
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
- Add relevant teams/collaborators (e.g., your engineering group) with admin permissions
- 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
- Protect
main
branch: - Enforce signed commits 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)
- 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
andCONTRIBUTING.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)
maksimryndin
Metadata
Metadata
Assignees
Labels
No labels