You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description:
There is no CONTRIBUTING.md in the TariffShield repository, which means every new contributor must ask teammates for setup instructions or discover conventions by trial and error during code review. A comprehensive CONTRIBUTING.md is needed that covers all prerequisites, the complete local development setup sequence, code style requirements enforced by CI, the pull request workflow including required reviewers and checks, how to run each test suite, and the commit message format used for semantic release. This document is the first file a new external or internal contributor reads and must be accurate enough to get a fresh machine to a running state independently.
Setup steps section provides numbered commands from git clone through docker-compose up -d, npm install, running migrations, and verifying GET /health returns 200
Code style section documents TypeScript conventions (strict mode, no any, import order), linting tools (eslint, prettier), and Rust conventions (clippy zero warnings, rustfmt) — with the exact commands to run them locally
PR workflow section explains branch naming convention (feat/, fix/, docs/), required CI checks that must pass before merge, minimum reviewer count, and how to request a review
Testing section explains how to run each suite: cargo test for contract unit tests, npm test in packages/sdk for SDK tests, npm test in apps/api for API integration tests, and npx playwright test for E2E tests
Commit message format section specifies the Conventional Commits pattern (feat:, fix:, docs:, chore:) and links to the semantic release configuration
A "Getting Help" section provides links to relevant documentation files (ARCHITECTURE.md, docs/local-dev.md) and the preferred channel for contributor questions
Relevant Files:
CONTRIBUTING.md — documentation file to create at repository root
apps/api/package.json — for test and lint script reference
apps/web/package.json — for test and lint script reference
packages/sdk/package.json — for test script reference
contracts/tariff-shield/Cargo.toml — for Rust toolchain reference
.github/workflows/ — for CI check names to reference in PR workflow section
Description:
There is no
CONTRIBUTING.mdin the TariffShield repository, which means every new contributor must ask teammates for setup instructions or discover conventions by trial and error during code review. A comprehensiveCONTRIBUTING.mdis needed that covers all prerequisites, the complete local development setup sequence, code style requirements enforced by CI, the pull request workflow including required reviewers and checks, how to run each test suite, and the commit message format used for semantic release. This document is the first file a new external or internal contributor reads and must be accurate enough to get a fresh machine to a running state independently.Acceptance Criteria:
wasm32-unknown-unknowntarget, Stellar CLI, Docker Desktop (for Postgres), and PostgreSQL client (psql)git clonethroughdocker-compose up -d,npm install, running migrations, and verifyingGET /healthreturns 200any, import order), linting tools (eslint,prettier), and Rust conventions (clippyzero warnings,rustfmt) — with the exact commands to run them locallyfeat/,fix/,docs/), required CI checks that must pass before merge, minimum reviewer count, and how to request a reviewcargo testfor contract unit tests,npm testinpackages/sdkfor SDK tests,npm testinapps/apifor API integration tests, andnpx playwright testfor E2E testsfeat:,fix:,docs:,chore:) and links to the semantic release configurationARCHITECTURE.md,docs/local-dev.md) and the preferred channel for contributor questionsRelevant Files:
CONTRIBUTING.md— documentation file to create at repository rootapps/api/package.json— for test and lint script referenceapps/web/package.json— for test and lint script referencepackages/sdk/package.json— for test script referencecontracts/tariff-shield/Cargo.toml— for Rust toolchain reference.github/workflows/— for CI check names to reference in PR workflow section