diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..75bf367 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing Guidelines + +Thank you for considering contributing to our project! We appreciate your efforts to improve our codebase. Please follow these guidelines to ensure smooth collaboration and efficient handling of pull requests. + +## Pull Request Process + +1. **Fork the Repository**: If you haven't already, fork the repository to your GitHub account. + +2. **Create a Branch**: Create a new branch for your feature or bug fix. Use a descriptive name that reflects the purpose of your changes. + +3. **Make Changes**: Make your changes to the codebase. Ensure that your modifications adhere to the project's coding standards and guidelines. + +4. **Test Your Changes**: Before submitting a pull request, test your changes locally to ensure they function as expected. If applicable, write tests to cover your code changes. + +5. **Commit Your Changes**: Commit your changes with clear and concise commit messages. Include details about what you have changed and why, Include in-depth documentation on changes both in the commits and in the pull requests, including any relevant context or reasoning. + + ```bash + git add . + git commit -m "Descriptive commit message" + ``` +6. **Push Your Changes**: Once you are satisfied with your changes, push your branch to your forked repository. + ```bash + git push origin + ``` +7. **Submit a Pull Request**: Go to the original repository (upstream) and create a pull request from your forked branch. Include in-depth documentation on changes both in the commits and in the pull requests, including any relevant context or reasoning. +8. **Review Process**: After submitting your pull request, a project maintainer will review your changes. Be responsive to any feedback or requests for revisions. +9. **Address Feedback**: If requested changes are needed, make the necessary updates to your branch and push the changes. Your pull request will be re-evaluated after the updates. +10. Merge: Once your pull request is approved and all checks pass, it will be merged into the main branch, Congratulations on your contribution!