Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (40 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 1.26 KB
Raw

Contributing

Branch workflow

main is protected. Do not push directly to main.

  1. Create a feature branch from main: 
    git checkout main
git pull
git checkout -b feat/your-change
  2. Commit your changes and push the branch: 
    git push -u origin feat/your-change
  3. Open a Pull Request into main on GitHub.
  4. Wait for CI to pass (JavaScript / TypeScript, Move contracts).
  5. Merge the PR (squash or merge commit — either is fine).

Branch naming

  • feat/ — new features
  • fix/ — bug fixes
  • chore/ — tooling, CI, docs
  • refactor/ — code changes without behavior change

Git hooks (strip Cursor co-author)

One-time setup in this repo:

chmod +x .githooks/prepare-commit-msg
git config core.hooksPath .githooks

Also disable in Cursor → Settings → Agents → Attribution (Commit + PR attribution off).

Local checks before opening a PR

pnpm install
pnpm build
pnpm test
pnpm lint
pnpm contracts:test

Releases & deploy

  • CI runs automatically on every PR and push to main.
  • CD (contract publish / frontend artifact) is manual via GitHub Actions → CD workflow.

See README.md for monorepo layout and package overview.