4. Pull Request
Completing a feature or fix in your development cycle means it's time to merge those changes through a pull request (PR). This guide provides a streamlined approach for creating a PR, ensuring consistency and efficiency.
Leverage GitHub's predefined templates to maintain uniformity and structure in your pull request submissions.
Select dev as the base branch and choose your branch as the source branch. This setup ensures that your changes are merged into the right environment.
Thoroughly document the changes in your PR to improve clarity and facilitate a smoother review process. While the template serves as a guide, it's advisable to fill out as much information as possible, even though not all fields are mandatory.
For those who prefer working within their IDE, Visual Studio Code offers a Pull Requests extension that allows you to create, view, and manage PRs directly. The extension provides a similar experience to using the GitHub website, with the same fields and boxes to fill in, ensuring a consistent PR creation process.
- At First make sure you remember to Assign pull request for yourself.
- Your PR title should adhere to your branch naming conventions and clearly summarize the purpose of the changes. This helps maintainers quickly understand what your PR addresses.
-
Issue Link: Begin the description with
Fixes #issue_numberto automatically link and close the related issue upon merging. -
Details: Provide a concise summary of the changes, any context for the modifications, and highlight areas of interest or potential risks that reviewers should consider.
After submitting your pull request, you can move on to other tasks. However, ensure that the CI tests pass successfully before proceeding. It's also important to monitor the PR for any feedback or requested changes from reviewers and address them promptly. This proactive approach helps ensure that your changes are integrated smoothly into the codebase.
- Don’t forget to update your branch’s project status to In Review.
If your pull request receives feedback with requested changes, address these changes promptly to keep the review process moving smoothly. After making the necessary updates, re-request a review from the reviewer to ensure they are aware of the adjustments.
- Assign to Issue when the work starts. Don't "reserve" issues.
- You may assign to 2 issues if the first one is awaiting Review in Pull Request