Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (47 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

66 lines (47 loc) · 1.26 KB

Contributing

Thanks for contributing to Blocs.

Ground Rules

  • Be respectful and follow the Code of Conduct.
  • Keep pull requests focused; avoid unrelated refactors.
  • Include tests for behavior changes whenever possible.
  • Do not commit secrets, private keys, or real credentials.

Local Setup

Frontend

cp .env.example .env
npm ci
npm run dev

Smart Contract (Anchor)

cd anchor
yarn install --frozen-lockfile
anchor build
yarn test

Validation Before Opening a PR

Run from repository root:

npm run lint
npm run typecheck
npm run test -- --run
npm run build

If you changed Anchor code, also run:

cd anchor
anchor build
yarn test

Pull Request Checklist

  • Describe the problem and the solution clearly.
  • Link related issues.
  • Add or update tests and docs.
  • Keep docs and .env.example in sync when changing env vars, workflows, or operational behavior.
  • Confirm CI is green.

Commit Guidance

Conventional commits are preferred but not required.

Signature Policy

  • Maintainer commits to main must be GitHub-verified signed commits.
  • Release tags must be annotated and signed tags.
  • Unsigned maintainer commits or unsigned release tags are blocked by CI.