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.
-
Fork the Repository: If you haven't already, fork the repository to your GitHub account.
-
Create a Branch: Create a new branch for your feature or bug fix. Use a descriptive name that reflects the purpose of your changes.
-
Make Changes: Make your changes to the codebase. Ensure that your modifications adhere to the project's coding standards and guidelines.
-
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.
-
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.
git add . git commit -m "Descriptive commit message"
-
Push Your Changes: Once you are satisfied with your changes, push your branch to your forked repository.
git push origin <your-branch-name>- 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.
- Review Process: After submitting your pull request, a project maintainer will review your changes. Be responsive to any feedback or requests for revisions.
- 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.
- Merge: Once your pull request is approved and all checks pass, it will be merged into the main branch, Congratulations on your contribution!