Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (36 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.03 KB

Contributing to Quorum

Thanks for wanting to contribute! Here's everything you need to get started.

Quick Start

git clone https://github.com/Solvely-Colin/Quorum.git
cd Quorum
npm install
npm run build

Development

Running Tests

npm test

Note: Test suite is coming soon. For now, manual testing is the way.

Linting

npm run lint

Note: Linting setup is coming soon.

Code Style

  • TypeScript in strict mode
  • ESM modules — no CommonJS
  • Keep it clean and readable

Pull Requests

  1. Branch from main
  2. Use descriptive commit messages
  3. One feature/fix per PR — keep it focused
  4. Make sure it builds (npm run build)
  5. Update docs if your change affects usage

Filing Issues

  • Search first — your issue might already exist
  • Use the templates — they're there to help
  • Be specific: steps to reproduce, expected vs actual behavior, environment details

Code of Conduct

Coming soon. In the meantime: be kind, be constructive, be collaborative.