First off, thank you for taking the time to contribute! 🎉
We welcome contributions from everyone, whether you're fixing bugs, adding new features, or improving documentation. Here are a few guidelines to help you get started.
By participating in this project, you agree to abide by the Code of Conduct. Please be respectful and considerate to others, as we want to foster a friendly and inclusive community.
We appreciate any help! There are several ways you can contribute to this project:
- If you find a bug, please check if it has already been reported. If not, open a new issue with a clear description of the problem and how to reproduce it.
- Provide any relevant information like logs, steps to reproduce, or screenshots to help us understand the issue better.
- If you have an idea for a new feature or improvement, please open an issue to discuss it first. This allows us to prioritize the feature and make sure it fits with the project vision.
- Clearly describe the idea and its potential impact.
- Fork the repository and create a new branch for your feature or bugfix.
- Write clear, descriptive commit messages.
- Follow the coding style used in the project (indentation, variable names, etc.).
- If applicable, add tests that ensure your changes work as expected.
- Submit a pull request with a description of what you've done and why.
- Make sure your changes pass any automated checks or tests (e.g., CI/CD pipeline).
- Fork the repository and clone it to your local machine.
- Create a new branch for your changes.
- Make the necessary changes and ensure the project works as expected.
- Commit your changes and push them to your fork.
- Open a pull request. Make sure to include a detailed description of what you've changed and why.
- After you submit a pull request, the maintainers will review it. If they have any questions or requests for changes, they will provide feedback.
- Address the feedback and make any necessary changes before the pull request is merged.
By contributing to this project, you agree that your contributions will be licensed under the same license as the project. See LICENSE for more details.
Thank you for contributing! 🎉 We appreciate your help in making this project better.