Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.63 KB
Raw

Contributing

Thank you for your interest in contributing! Whether it's reporting bugs, discussing improvements, proposing new features, or writing and reviewing code, your contributions are welcome.

Getting Started

  • Fork the repository on GitHub.
  • Clone your forked repository to your local machine.
  • Set up your environment and make sure that the tests pass.

Reporting Issues

  • Check that the issue has not already been reported.
  • Check that the issue has not already been fixed in the latest code.
  • Be clear, concise and precise in your description of the problem.
  • Open an issue with a descriptive title and a summary in grammatically correct, complete sentences.

Code Contributions

Here is a quick guide on how to contribute code:

  1. Fork the project and clone your fork.
  2. Create a new branch for your feature or bugfix.
  3. Commit your changes in logical units.
  4. Make sure your commit messages are well formatted.
  5. Push your changes to a branch in your fork of the repository.
  6. Open a pull request, and describe the changes as clearly as possible.

Code Style

Please adhere to the coding conventions used throughout the project. In particular:

  • Use proper variable naming conventions.
  • Comment your code where necessary.

Pull Requests

  • PRs are welcome! If you see something that could be improved, a new feature that you think would be useful, or a bug you think you can fix, we would love to review your contributions.
  • Please make sure that your PR includes tests and your changes don't break the existing tests.
  • Please ensure you have merged the latest changes from the main branch before creating your PR.