Skip to content

Comply Repo to NethermindEth/rust-template #76

@cupicmarko

Description

@cupicmarko

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)[https://github.com/NethermindEth/rust-template/blob/main/.github/workflows/build-and-test.yml] main branch:
  • Enforce signed commits on all branches
  • Verify SECURITY.md is present and up‑to‑date

CI / Tooling / Code standards

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)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions