Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.69 KB

Contributing

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Review and sign our Contributor License Agreement and send it to our IP team at [email protected].

How to Contribute

There are many ways to contribute, including:

  • Reporting Bugs: If you find a bug, please open an issue describing the problem in detail. Include steps to reproduce, expected behavior, and any relevant error messages.
  • Suggesting Enhancements: Have an idea for a new feature or improvement? Open an issue to discuss it with us.
  • Improving Documentation: Help make our documentation clearer and more helpful by suggesting changes or fixing errors.
  • Submitting Pull Requests (PRs): The best way to contribute code is by submitting a pull request. Before you start working on a major change, please open an issue to discuss the proposed change first.

Pull Request Guidelines

  1. Fork the repository: Create your own copy of the repository.
  2. Create a branch: Make your changes on a new branch.
  3. Write clear commit messages: Explain what each commit does.
  4. Follow coding style: Match the existing code style as closely as possible.
  5. Add tests: Include tests for your changes (if applicable).
  6. Open a pull request: Submit your changes for review.