Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (21 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.16 KB
Raw

Contributing

Thanks for considering a contribution — issues and pull requests are welcome.

Getting started

  1. Fork the repository and clone your fork.
  2. Install dependencies and run the project as described in the README.
  3. Create a branch for your change: git checkout -b my-change.

Making a change

  • Keep pull requests focused and describe what changed and why.
  • Run the project's format, lint, and test steps (see the README) before pushing.
  • Add or update tests when you change behavior.
  • Update docs or the CHANGELOG when relevant.

Good first issues

New here? Look for issues labeled good first issue — they're small, scoped, and have enough context to start. Ask questions right in the issue; I usually reply within a day.

Reporting bugs and ideas

Open an issue using the provided templates. Clear reproduction steps (for bugs) or a concrete use case (for ideas) help a lot.

By contributing, you agree that your contributions will be licensed under the same license as this project, and that you will follow the Code of Conduct.