diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b183dae --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,72 @@ +# Contributing to solvecaptcha-python + +Thank you for considering contributing to the solvecaptcha-python! By contributing, you're helping improve the project and enabling others to benefit from your improvements. + +Here are a few guidelines to help you get started. + +## How to Contribute + +1. **Fork the repository** + If you'd like to contribute, please start by forking the project and cloning it to your local machine. + + ```bash + git clone https://github.com/solvercaptcha/solvecaptcha-python.git + ``` + +2. **Create a new branch** + Create a new branch for your feature or bug fix. This will help keep your changes separate from the main codebase. + + ```bash + git checkout -b my-feature-branch + ``` + +3. **Make your changes** + Modify the code or documentation as needed. Make sure to follow the project's coding style and conventions. + +4. **Test your changes** + Ensure that your changes work as expected and do not break anything in the project. If applicable, write tests to cover your changes. + +5. **Commit your changes** + After you've made your changes, commit them with a meaningful message describing what you've done. + + ```bash + git commit -m "Add feature X to bypass challenge" + ``` + +6. **Push your changes** + Push your changes to your forked repository. + + ```bash + git push origin my-feature-branch + ``` + +7. **Submit a pull request** + Navigate to the original repository and submit a pull request. Describe the changes you've made and why they're important. + + We will review your pull request and get back to you as soon as possible! + +## Reporting Issues + +If you find any bugs or issues with the project, feel free to open an issue in the **Issues** tab. When reporting an issue, please provide the following information: + +- A detailed description of the issue. +- Steps to reproduce the issue. +- Any relevant error messages or logs. + +## Code of Conduct + +By contributing to this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). Please be respectful and considerate to other contributors. + +## Types of Contributions + +Here are some ways you can contribute to the project: + +- **Bug Fixes**: If you find a bug, feel free to submit a pull request with a fix. +- **Feature Requests**: Have a great idea for a new feature? Open an issue to discuss it! +- **Documentation**: Help improve the documentation or add new guides to make the project more accessible to others. +- **Tests**: Ensure that the project is thoroughly tested and improve the test coverage. +- **Code Refactoring**: Help improve the project codebase by refactoring or optimizing the code. + +## Thank You! + +Your contributions are greatly appreciated! Together, we can make this project even better for everyone.