Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.35 KB
Raw

Contributing

Thank you for considering to contribute. This document outlines some guidelines for contributing to this open source project.

Please make sure to review our Code of Conduct.

There are several ways you can contribute to the betterment of the project:

  • Report an issue? - If the issue isn't reported, we can't fix it. Please report any bugs, feature, and/or improvement requests through the issue tracker.
  • Submit patches - Do you have a new feature or a fix you'd like to share? Submit a pull request

Issues

If you encounter any issues with the project, please check if the issue has already been reported. If the issue hasn't been reported, please open a new issue with a clear description of the problem and steps to reproduce it.

Pull Requests

Please keep the following guidelines in mind when opening a pull request:

  • Ensure that your code passes the project's test suite.
  • Provide a clear and detailed description of your changes.
  • Keep your changes focused on a single concern.
  • Write clean and readable code that follows the project's code style.
  • Use descriptive variable and function names.
  • Write clear and concise commit messages.
  • Add tests for your changes, where applicable.
  • Ensure that your changes don't break existing functionality.

Commit message guidelines

Our commit messages adhere to the Conventional Commits specification. Please read the specification so we can automatically parse your commits when generating our Changelogs.

Development

The main branch is regularly built and tested, but it is not guaranteed to be completely stable. Tags are created regularly from release branches to indicate new official, stable release versions.

  1. Fork the project repository.
  2. Create a new branch for your contribution.
  3. Write your code or make the desired changes.
  4. Ensure that your code passes the project's by running the test suite
  5. Commit your changes and push them to your forked repository.
  6. Open a pull request to the main project repository with a detailed description of your changes.

License

This project is released under the MIT License. By contributing to this project, you agree to license your contributions under the same license.