Skip to content

Commit f927928

Browse files
authored
Merge pull request #8895 from kenjis/imporve-contributing
docs: imporve contributing
2 parents 5eb9584 + 3f5aecc commit f927928

File tree

2 files changed

+24
-17
lines changed

2 files changed

+24
-17
lines changed

contributing/pull_request.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,10 +200,13 @@ working on your contribution.
200200

201201
### Branching
202202

203-
All bug fixes should be sent to the __"develop"__ branch, this is where the next
204-
bug fix version will be developed.
203+
- All bug fix PRs should be sent to the __"develop"__ branch, this is where the
204+
next bug fix version will be developed.
205+
- PRs with any enhancement should be sent to next minor version branch, e.g. __"4.6"__
205206

206-
PRs with any enhancement should be sent to next minor version branch, e.g. __"4.6"__
207+
> [!NOTE]
208+
> If you sent your PR to the wrong branch, see
209+
> [Contribution Workflow](./workflow.md#if-you-sent-to-the-wrong-branch).
207210
208211
The __"master"__ branch will always contain the latest stable version and is kept
209212
clean so a "hotfix" (e.g. an emergency security patch) can be applied to the
@@ -235,6 +238,10 @@ This is *not* just a "signed-off-by" commit, but instead, a digitally signed one
235238

236239
See [Contribution signing](./signing.md) for details.
237240

241+
> [!NOTE]
242+
> If you forgot GPG-signing your commits, see
243+
> [Contribution Workflow](./workflow.md#gpg-signing-old-commits).
244+
238245
### Static Analysis on PHP code
239246

240247
We cannot, at all times, guarantee that all PHP code submitted on pull requests

contributing/workflow.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ values for when you try these:
1818

1919
- All bug fix PRs should be sent to the __"develop"__ branch, this is where the
2020
next bug fix version will be developed.
21-
- PRs with any enhancement should be sent to next minor version branch, e.g. __"4.5"__
21+
- PRs with any enhancement should be sent to next minor version branch, e.g. __"4.6"__
2222

2323
The "master" branch will always contain the latest stable
2424
version and is kept clean so a "hotfix" (e.g: an emergency security
@@ -114,7 +114,7 @@ is optional, and implies a sort of namespacing if used.
114114

115115
- All bug fix PRs should be sent to the __"develop"__ branch, this is where the
116116
next bug fix version will be developed.
117-
- PRs with any enhancement should be sent to next minor version branch, e.g. __"4.5"__
117+
- PRs with any enhancement should be sent to next minor version branch, e.g. __"4.6"__
118118

119119
For instance, if you send a PR to __"develop"__ branch, make sure you are in the
120120
*develop* branch, and create a new bugfix branch, based on *develop*, for a new
@@ -126,11 +126,11 @@ feature you are creating:
126126
```
127127

128128
If you send a PR with an enhancement, make sure you are in the *next minor version*
129-
branch, and create a new feature branch, based on, e.g., __"4.5"__, for a new
129+
branch, and create a new feature branch, based on, e.g., __"4.6"__, for a new
130130
feature you are creating:
131131

132132
```console
133-
> git switch 4.5
133+
> git switch 4.6
134134
> git switch -c new/mind-reader
135135
```
136136

@@ -283,7 +283,7 @@ switching to the branch you wish to contribute, and then clicking on
283283
"New pull request".
284284

285285
Make sure the pull request is for the shared __"develop"__ or next minor version
286-
branch, e.g. __"4.5"__, or it may be rejected.
286+
branch, e.g. __"4.6"__, or it may be rejected.
287287

288288
Make sure that the PR title is helpful for the maintainers and other
289289
developers. Add any comments appropriate, for instance asking for
@@ -324,7 +324,7 @@ And if your PRs have the breaking changes, label the following label:
324324
If you are asked for changes in the review, commit the fix in your branch and
325325
push it to GitHub again.
326326

327-
If the __"develop"__ or next minor version branch, e.g. __"4.5"__, progresses
327+
If the __"develop"__ or next minor version branch, e.g. __"4.6"__, progresses
328328
and conflicts arise that prevent merging, or if you are asked to *rebase*,
329329
do the following:
330330

@@ -364,7 +364,7 @@ And finally push your local branch to your GitHub repository:
364364

365365
If you have sent a PR to the wrong branch, you need to create a new PR branch.
366366

367-
When you have the PR branch `feat-abc` and you should have sent the PR to __"4.5"__,
367+
When you have the PR branch `feat-abc` and you should have sent the PR to __"4.6"__,
368368
but you created the PR branch from `develop` and sent a PR.
369369

370370
Copy the IDs of any commits you made that you want to keep:
@@ -373,13 +373,13 @@ Copy the IDs of any commits you made that you want to keep:
373373
> git log
374374
```
375375

376-
Update your __"4.5"__ branch:
376+
Update your __"4.6"__ branch:
377377

378378
```console
379379
> git fetch upstream
380-
> git switch 4.5
381-
> git merge upstream/4.5
382-
> git push origin 4.5
380+
> git switch 4.6
381+
> git merge upstream/4.6
382+
> git push origin 4.6
383383
```
384384

385385
(Optional) Create a new branch as a backup, just in case:
@@ -388,10 +388,10 @@ Update your __"4.5"__ branch:
388388
> git branch feat-abc.bk feat-abc
389389
```
390390

391-
Rebase your PR branch from `develop` onto __"4.5"__:
391+
Rebase your PR branch from `develop` onto __"4.6"__:
392392

393393
```console
394-
> git rebase --onto 4.5 develop feat-abc
394+
> git rebase --onto 4.6 develop feat-abc
395395
```
396396

397397
Force push.
@@ -400,7 +400,7 @@ Force push.
400400
> git push --force-with-lease origin feat-abc
401401
```
402402

403-
On the GitHub PR page, change the base branch to the correct branch __"4.5"__.
403+
On the GitHub PR page, change the base branch to the correct branch __"4.6"__.
404404

405405
## Cleanup
406406

0 commit comments

Comments
 (0)