Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (26 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.9 KB

Contributing Guidelines

We welcome contributions from the community to improve our project. Before you start contributing, please take a moment to review these guidelines.

Reporting Issues

If you find a bug, encounter a problem, or have a suggestion, please open an issue on our issue tracker. Provide a clear and detailed description of the issue, including steps to reproduce it.

Pull Requests

We appreciate your contributions through pull requests. To submit a pull request:

  1. Fork the repository and create a new branch from main.
  2. Make your changes, following the coding style and guidelines of the project.
  3. Ensure that your code is well-documented, tested, and does not introduce any regressions.
  4. Make sure your branch is up-to-date with the latest changes from main.
  5. Open a pull request, describing the changes you've made and their purpose.

Code Style and Guidelines

  • Adhere to the coding style and conventions used in the project.
  • Write clear and concise commit messages, explaining the purpose of each commit.
  • Keep code changes focused and small for easier review and maintenance.
  • Add appropriate tests for new functionality or bug fixes.
  • Ensure all tests pass before submitting a pull request.

Licensing

By contributing, you agree that your contributions will be licensed under the project's license.

Code of Conduct

Please follow our Code of Conduct while participating in this project.

Attribution

These contributing guidelines are adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Thank you for considering contributing to our project! Your involvement is greatly appreciated.

Note: This CONTRIBUTING.md document is subject to change and updates. Please refer back to this document periodically.