diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33ab7c93..64967e2c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,15 +34,16 @@ defined in the Apache License shall be dual-licensed as above, without any addit with `chmod +x .git/hooks/pre-push` .This will run when you do `git push` and will make the push quite slow, but please give it time to complete as this helps to fix any issues locally and not rely just on running `ci` on GitHub when you create the PR -13. Commit and push your changes, and if there are any errors, fix them before you push them -14. Create a `PR` back to the `parent` repo targeting the `main` branch with the title as the GitHub issue title, including `#ID`. Also, include the link to GitHub issue in the description saying like `Fix for ` for bugs or `Implementation for ` for features and others -15. Request review from +13. Commit the changes and make sure to include the ` <#ID>` of the GitHub issue in the message. This will make the commits visible in the context of the issue so we can clearly see a clean history of all changes +14. Push your changes, and if there are any errors, fix them before you push them +15. Create a `PR` back to the `parent` repo targeting the `main` branch with the title as the GitHub issue title, including `#ID`. Also, include the link to GitHub issue in the description, saying like `Fix for <link>` for bugs or `Implementation for <link>` for features and others +16. Request review from owners of the repository by adding them to the `Reviewers` field -16. In the project, move the item to `In Code Review` -17. Monitor the checks (GitHub actions runs) and fix the code if they are failing -18. Respond to any comments -19. **DON'T MERGE THE PR YOURSELF. LEAVE THAT TO REPOSITORY OWNERS** -20. In the end, ideally, it will be merged into `main` +17. In the project, move the item to `In Code Review` +18. Monitor the checks (GitHub actions runs) and fix the code if they are failing +19. Respond to any comments +20. **DON'T MERGE THE PR YOURSELF. LEAVE THAT TO REPOSITORY OWNERS** +21. In the end, ideally, it will be merged into `main` # QA manual