Thank you for considering contributing to our project! We welcome and appreciate contributions from everyone.
The following is a set of guidelines for contributing to our project. These guidelines are designed to make the contribution process easy and effective for everyone involved.
We expect all contributors to adhere to our Code of Conduct. Please read it carefully before making any contributions.
If you encounter a bug, please report it to us by creating a new issue in our issue tracker. Please include as much detail as possible, such as a description of the bug, steps to reproduce it, and the expected outcome.
If you have an idea for how to enhance our project, please let us know by creating a new issue in our issue tracker. Please include as much detail as possible, such as a description of the enhancement, why it would be useful, and any potential challenges.
We welcome pull requests! To contribute code to our project, please follow these steps:
- Fork the repository to your own GitHub account.
- Clone the repository to your local machine.
- Create a new branch with a descriptive name for your changes.
- Make your changes to the codebase.
- Commit your changes with a clear and descriptive commit message.
- Push your branch to your forked repository.
- Create a pull request from your branch to our main repository.
Please ensure that your code follows our coding standards and that you have tested it thoroughly before submitting a pull request.
At the moment, we don't have any specific rules about writing other people's code. However, this does not mean that you can write bad code or spaghetti code. Please follow well known code standards.
All pull requests will be reviewed by our team before being merged. We appreciate feedback and suggestions for improvement, and we may ask you to make changes before merging your code.
We appreciate any contributions to our project, whether they come in the form of bug reports, enhancement suggestions, or code contributions. Thank you for helping make our project better!