Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (31 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1.47 KB

Contributing

Thank you for your interest in contributing! This guide applies to all repositories in this organization.

How to Contribute

Reporting Bugs

  1. Check if the issue already exists
  2. Use the Bug Report template
  3. Include steps to reproduce, expected vs. actual behavior

Suggesting Features

  1. Use the Feature Request template
  2. Describe the use case, not just the solution

Submitting Code

  1. Fork the repository (or create a feature branch if you have write access)
  2. Use branch naming: feature/, fix/, docs/
  3. Follow the code style (Python: ruff, JS: prettier)
  4. Write clear commit messages: type: description
    • Types: feat, fix, docs, refactor, test, chore
  5. Open a Pull Request with the PR template filled out
  6. Wait for review (usually within 7 days)

Code Style

  • Python: Follow ruff defaults, type hints encouraged
  • JavaScript/TypeScript: Follow prettier defaults
  • Markdown: One sentence per line for better diffs

Pull Request Process

  1. PRs require at least 1 approving review
  2. All conversations must be resolved before merge
  3. Keep PRs focused — one feature or fix per PR
  4. Update documentation if your change affects usage

Code of Conduct

We follow the Contributor Covenant v2.1. Be respectful, inclusive, and constructive.

Questions?

Open a Discussion (Q&A category) or create an issue with the Question template.