Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.42 KB

Contributing to Simtabi open source

Thank you for considering a contribution. This is the organization-wide guide; individual repositories may add project-specific instructions in their own CONTRIBUTING.md, which takes precedence.

Before you start

  • Bugs: open an issue on the affected repository with a minimal reproduction.
  • Features: open an issue describing the problem you want solved before writing code — it saves everyone time if we agree on the direction first.
  • Security: never via public issues; see SECURITY.md.

Pull requests

  1. Fork the repository and create a branch from main.
  2. Keep the change focused — one concern per pull request.
  3. Match the existing code style; run the project's formatter and linters (most repositories expose them via composer, make, or npm scripts).
  4. Add or update tests for behavior you change; the test suite must pass.
  5. Update documentation (README.md, docs/) when behavior or usage changes.
  6. Write commit subjects in the imperative mood, 72 characters or fewer, with the body explaining why.

Conventions

  • Default license is MIT; contributions are accepted under the repository's license.
  • Be kind and constructive — all participation is covered by our code of conduct.

Questions

opensource@simtabi.com, or the issue tracker of the repository concerned.