Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (27 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.15 KB

Contributing to cellar-door-entry

Thanks for your interest in contributing!

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

Reporting Bugs

  • Use GitHub Issues
  • Include steps to reproduce, expected vs actual behavior, and your environment
  • Check existing issues first

Pull Requests

  1. Fork the repo and create a branch from main
  2. Make your changes — keep commits focused
  3. Write tests — all PRs require tests
  4. Run npm test and ensure everything passes
  5. Open a PR with a clear description

PR Guidelines

  • One concern per PR
  • Reference related issues (Closes #42)
  • Ensure CI passes before requesting review

Code Style

  • TypeScript (strict mode)
  • Vitest for tests
  • Files: kebab-case.ts, Types: PascalCase, Functions: camelCase
  • Test files: *.test.ts in src/__tests__/

AI-Assisted Contributions

AI-assisted contributions are welcome. Same quality standards apply regardless of authorship.

Questions?

Open an issue or reach out to maintainers in GOVERNANCE.md.