Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (29 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 1.87 KB

Contributing

In the spirit of free software, I encourage everyone to help improve this project. Here are some ways you can contribute:

  • Report bugs.
  • Suggest new features.
  • Write or edit documentation.
  • Write specifications.
  • Write code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace).
  • Refactor code.
  • Write and/or work on issues.
  • Review patches on discussions.
  • Be creative: any contribution is welcome!

Submitting an issue

This project uses the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure no one else has already submitted the same bug report.

When submitting a bug report, please include any details that may be necessary to reproduce the bug, including the version of the project, Python/Node/Bun versions, and operating system.

Writing code

After you run make install, pre-commit will be installed. Make sure to always run the pre-commits before committing and making PRs. If you’re adding new functionality, it would be awesome if you could also provide tests and documentation to cover it, but don't let this stop you from contributing.

Submitting a pull request

  1. Fork the repository;
  2. Create a topic branch (e.g. feat/adding-xyz, fix/abc, etc);
  3. Implement your feature or bug fix;
  4. Consider adding tests and/or documentation for your feature or bug fix;
  5. Run make pre-commit;
  6. Commit and push your changes to your branch;
  7. Submit a pull request.

License

By contributing, you agree that your contributions will be licensed under its MIT license.