-
Notifications
You must be signed in to change notification settings - Fork 191
Pull Requests
A pull request indicates that a code merge is being proposed. At this point, others can review the proposed code, discuss different solutions, and add additional changes.
A good pull request:
- Satisfies all of the acceptance criteria within the issue.
- Serves a singular purpose related to one issue, not many.
- Includes relevant screenshots, GIFs, or video to assist the reviewer.
- Uses @ mentions to tag team members on specific parts which may need special attention.
<issue title> #<issue number>
Each pull request title should include the issue title followed by the issue number.
Tip: When you view an individual GitHub issue, it displays the issue title followed by the issue number at the top of the page, so it can simply be copied and pasted as the pull request title.
Given an issue number 123 and issue title fix: improve vertical rhythm, the relevant pull request should be named:
fix: improve vertical rhythm #123
Pull requests are generated from the comparison of two branches.
For pull requests that correspond to an issue, the branch should follow the issue/<issue number> naming convention. So if the issue is 123 the pull request branch would be issue/123. The branch to compare against is derived from the issue's assigned release. If the release is 1.3.0, then compare against the release/1.3.0 branch to generate the pull request. If no such branch exists or a release isn't assigned to the issue, reach out to a senior developer.
If a pull request is being quickly made to fix an urgent problem, the convention is hotfix/brief-problem-title. Ask a senior developer which release branch this should be compared against to generate the pull request.
Once the pull request is merged, the development branch will be deleted.
- Begin each pull request title with the relevant issue's title.
- End each pull request title with the issue number.
- Do not make up a new title for the pull request. Use the same title text as the issue.
-
Support/Marketing/Community
- Submit PR
-
Development
- Submit PR
- Code review
-
Senior Development
- Submit PR
- Code review
- Merge PR
This Wiki is focused on GiveWP development. For help using our WordPress plugin, head over to our website where you'll find Plugin Documentation and Support.