Skip to content

Commit 3159371

Browse files
authored
Add new section, Guidance for merging pull requests (#1926)
* Add new section, Guidance for merging pull requests * Move to better location * Update merge request message, per @wesleybl feedback
1 parent e9204bc commit 3159371

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

docs/contributing/index.md

+26-5
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ To contribute to any project in Plone, you must follow the policies of the [Plon
2020
This chapter covers policies that apply to all Plone projects.
2121
Other chapters cover any variations and additional policies for each project.
2222

23+
2324
(contributing-sign-and-return-the-plone-contributor-agreement-label)=
2425

2526
## Sign and return the Plone Contributor Agreement
@@ -77,6 +78,7 @@ Someone will help identify in which of the dozens of repositories that make up P
7778
```{include} /_inc/_continuous-integration.md
7879
```
7980

81+
8082
(contributing-change-log-label)=
8183

8284
## Change log entry
@@ -102,11 +104,11 @@ When making a change to its documentation, set up, continuous integration, or ot
102104

103105
The change log entry's format must be `###.type`, where `###` is the referenced GitHub issue or pull request number, `.` is the literal extension delimiter, and `type` is one of the following strings.
104106

105-
- `breaking` for breaking changes
106-
- `bugfix` for bug fixes
107-
- `documentation` for documentation
108-
- `feature` for new features
109-
- `internal` for internal changes
107+
- `breaking` for breaking changes
108+
- `bugfix` for bug fixes
109+
- `documentation` for documentation
110+
- `feature` for new features
111+
- `internal` for internal changes
110112

111113
A package configures the types it allows in a file `towncrier.toml` located at the root of its package directory.
112114

@@ -156,6 +158,25 @@ To standarize the developer experience across packages, a configuration tool is
156158

157159
See the [tool documentation](https://github.com/plone/meta) for more information.
158160

161+
162+
(contributing-guidance-for-merging-pull-requests-label)=
163+
164+
## Guidance for merging pull requests
165+
166+
- If you have any doubt, don't merge, but ask.
167+
- All {doc}`CI checks <core/continuous-integration>` must pass, unless there is a good reason to ignore it.
168+
If you ignore a check, then write the good reason either in a comment or in the merge message.
169+
- Get at least one approval from another Plone contributor, preferably a member of the GitHub Team for the repository.
170+
- If the pull request has documentation, ask for a review from `@plone/documentation-team`.
171+
- Usually the merge message populates with all the commit messages, but some repositories aren't configured to do this.
172+
It's helpful to include a descriptive message in the merge request.
173+
- After merging, look for any linked issues that should be closed, and close them.
174+
Sometimes the contributor forgets to include `closes #123` in the description, which would automatically close the related issue.
175+
- If the change is a bugfix, make sure that it is not merged to an older release branch unless it is also merged in separate pull request to `main`.
176+
- Thank the contributor.
177+
- 🍻
178+
179+
159180
(contributing-specific-contribution-policies-for-projects-label)=
160181

161182
## Specific contribution policies of projects

0 commit comments

Comments
 (0)