Thank you for considering contributing to this project! Please take a moment to review the following guidelines.
- Code of Conduct
- How to Contribute
- Submitting Changes
- Coding Standards
- Issue and Bug Reports
- Feature Requests
- License
This project and its community follow the Contributor Covenant Code of Conduct. By participating in this project, you are expected to uphold this code.
Contributions are welcome from everyone. For major changes, please open an issue first to discuss what you would like to change.
To get started, please follow these steps:
- Fork the repository.
- Clone your forked repository to your local machine.
- Create a new branch for your changes.
- Make your changes and commit them with a descriptive commit message.
- Push your changes to your forked repository.
- Open a pull request to this repository.
Before submitting changes, please ensure the following:
- Your code follows the coding standards (see Coding Standards).
- Your changes are thoroughly tested.
- Your changes do not break the existing functionality.
- Your commits have descriptive commit messages.
Please follow the existing coding standards in this project. If you are unsure, refer to the existing codebase or ask for clarification.
If you encounter an issue or a bug, please create a new issue and include the following information:
- Description of the issue or bug.
- Steps to reproduce the issue or bug.
- Expected behavior.
- Actual behavior.
- Your environment (e.g. operating system, version of the project, etc.)
If you would like to request a new feature, please create a new issue and include the following information:
- Description of the feature.
- Why the feature is needed.
- Possible implementation options (if known).
By contributing to this project, you agree that your contributions will be licensed under the MIT License.