docs: add CONTRIBUTING.md (fixes broken link from README) - #42
Open
danilaverbena wants to merge 1 commit into
Open
danilaverbena wants to merge 1 commit into
danilaverbena wants to merge 1 commit into
Conversation
The README links to CONTRIBUTING.md from the Get Involved section, but the file does not exist, so the link 404s. This adds a contributing guide tailored to the project: build/test commands for the Cargo workspace, the development workflow (fmt/clippy/test, Conventional Commits), a consensus-determinism warning around the pinned BCS encoding, a PR checklist, security-reporting guidance, and licensing/community pointers.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The README's Get Involved section points contributors to a contributing guide:
but there is no
CONTRIBUTING.mdin the repository, so the link 404s. New contributors following it hit a dead end.Change
Adds a
CONTRIBUTING.mdtailored to Setu rather than a generic template:good-first-issue, aligned with the existing issue templates.cargo build --release/cargo test --all, plus thescripts/helpers for local multi-validator/e2e runs.cargo fmt/cargo clippy -D warnings/cargo test --all→ Conventional Commits → PR againstmainlinking the issue.bcs = "=0.1.6"without a coordinated state migration (mirrors the note in the rootCargo.toml).LICENSEfile), and community links.This fixes the broken README link and gives contributors a concrete starting point.
Notes
LICENSEfile rather than naming a license, to avoid asserting one. (Heads-up for maintainers: the README's License section currently says Apache License 2.0, while the committedLICENSEfile is AGPL-3.0 — worth reconciling in a separate change.)Happy to adjust tone, sections, or specifics to match how the team prefers to work.