Skip to content

Add a CONTRIBUTING guide covering branch naming, tests, and the PR checklist #24

Description

@mikewheeleer

Document the contribution workflow in a CONTRIBUTING guide

Description

The Contributing section in README.md is two lines and does not describe branch naming, the Jest/Testing Library conventions used in src/**/__tests__, or the local checks the CI in .github/workflows/ci.yml runs (npm ci, npm run build, npm test). This issue adds a dedicated CONTRIBUTING.md so external contributors can ship merge-ready PRs.

Requirements and context

  • Repository scope: StableRoute-Org/Stableroute-frontend only.
  • Create CONTRIBUTING.md covering: fork + branch naming (type/area-slug), running npm run dev/build/test/lint, and the testing patterns (Testing Library, jest-dom, mocking fetch/next/navigation).
  • Mirror the CI steps so "passes locally" matches "passes in CI"; reference jest.config.js and jest.setup.ts.
  • Add a short PR checklist (tests added, lint/build/test green, docs updated, a11y considered).
  • Link to it from the README Contributing section.

Suggested execution

  • Fork the repo and create a branch
  • git checkout -b docs/contributing-24-guide
  • Implement changes
    • Write code in: n/a (docs).
    • Write comprehensive tests in: n/a — verify npm run build and commands referenced are accurate.
    • Add documentation: create CONTRIBUTING.md and link from README.md.
    • Ensure all referenced scripts exist in package.json.
    • Validate Markdown and link correctness.
  • Test and commit

Test and commit

  • Run npm run lint and the documented commands to confirm they work as written.
  • Cover edge cases: every command runs, branch convention matches issue slugs, and links resolve.
  • Include a rendered preview note in the PR description.

Example commit message

docs: add CONTRIBUTING guide with branch, test, and PR conventions

Guidelines

  • Minimum 95 percent test coverage for impacted modules.
  • Clear, reviewer-focused documentation.
  • Timeframe: 96 hours.

Community & contribution rewards

  • 💬 Join the StableRoute community on Discord for questions, reviews, and faster merges: https://discord.gg/37aCpusvx
  • ⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — if this issue and the maintainers helped you ship, we'd be grateful for a 5-star rating. Clear questions in Discord and tidy, well-tested PRs are the fastest path to a merge and a reward.

Metadata

Metadata

Assignees

No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions