Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (33 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 1.14 KB

Contributing to CodeGate

Thanks for contributing.

Development Workflow

  1. Fork and clone the repository.
  2. Create a topic branch from main.
  3. Install dependencies: 
    npm install
    This also installs the Husky-managed pre-commit hook, which runs staged-file linting and formatting before a commit is created.
  4. Run local verification before pushing: 
    npm run lint
npm run typecheck
npm run test
npm run build
  5. Open a pull request with:
    • clear problem statement
    • implementation summary
    • test evidence

Commit Guidelines

  • Use focused commits.
  • Use Conventional Commit prefixes (feat:, fix:, docs:, test:, chore:, etc.). These drive automatic versioning and release.
  • Use ! or BREAKING CHANGE: for backwards-incompatible changes.
  • Keep unrelated changes out of the same PR.

Pull Request Expectations

  • Add or update tests for behavior changes.
  • Update docs for user-visible changes.
  • Keep CI green.

Reporting Security Issues

Please do not open public issues for vulnerabilities. See SECURITY.md and follow the private disclosure process.