Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (47 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 1.78 KB
Raw

Contributing

ARCE is intentionally focused. Contributions should improve reliability, clarity, or operator usability without turning the project into a generic API gateway.

Local Setup

  1. Install Node.js >=20.
  2. Install dependencies:
npm install
  1. Start Redis:
docker compose up
  1. Start the server:
npm run dev

Note on Authentication: If you set API_KEY in your .env file, you must pass x-api-key in your request headers when testing locally. Leaving API_KEY empty disables authentication for easier development.

  1. Optional smoke check:
npm run smoke

Useful Commands

npm run build
npm run typecheck
npm run lint
npm run test
npm run format
npm run format:check

Coding Standards

  • Keep the core system focused on rate limiting, adaptive control, and abuse detection.
  • Prefer small composable modules over large framework-style abstractions.
  • Treat Redis operations as concurrency-sensitive code paths. Atomicity claims should be explicit and justified.
  • Do not add speculative infrastructure features.
  • Keep public APIs and config changes documented in README.md and docs/.

Pull Request Guidelines

  • Open an issue first for large changes or behavioral changes.
  • Keep PRs scoped. Separate refactors from behavioral changes when possible.
  • Add or update tests for code that changes behavior.
  • Include a short note on risk: what changed, what could regress, and how you verified it.
  • Run npm run build, npm run lint, and npm run test before submitting.

Documentation Expectations

If you change:

  • API behavior: update README.md
  • system design: update docs/architecture.md or docs/design-decisions.md
  • configuration: update .env.example and the configuration section in README.md