You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update "Submit a Pull Request" page (#17712)
* update "Submit a Pull Request" page
* minor clarifications
* keep Conventional Commits info in step 2
* message format is enforced when PR is created
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
* pull request number
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
---------
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Copy file name to clipboardExpand all lines: docs/src/contribute/pull-requests.md
+11-18Lines changed: 11 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ Longer description here if necessary
63
63
Fixes #1234
64
64
```
65
65
66
-
The first line of the commit message (the summary) must have a specific format. This format is checked by our build tools.
66
+
The first line of the commit message (the summary) must have a specific format. This format is checked by our build tools. Although the commit message is not checked directly, it will be used to generate the title of a pull request, which will be checked when the pull request is submitted.
chore: Upgrade Esprima to 1.2, switch to using comment attachment
92
92
```
93
93
94
-
The commit message format is important because these messages are used to create a changelog for each release. The tag and issue number help to create more consistent and useful changelogs.
95
-
96
94
### Step 3: Rebase onto upstream<aname="step3"></a>
97
95
98
96
Before you send the pull request, be sure to rebase onto the upstream source. This ensures your code is running on the latest available code.
@@ -116,8 +114,6 @@ If there are any failing tests, update your code until all tests pass.
116
114
117
115
With your code ready to go, this is a good time to double-check your submission to make sure it follows our conventions. Here are the things to check:
118
116
119
-
* Make sure your commit is formatted correctly.
120
-
* The pull request must have a description. The description should explain what you did and how its effects can be seen.
121
117
* The commit message is properly formatted.
122
118
* The change introduces no functional regression. Be sure to run `npm test` to verify your changes before submitting a pull request.
123
119
* Make separate pull requests for unrelated changes. Large pull requests with multiple unrelated changes may be closed without merging.
@@ -145,27 +141,24 @@ Now you're ready to send the pull request. Go to your ESLint fork and then follo
145
141
146
142
In order to submit code or documentation to an ESLint project, you’ll be asked to sign our CLA when you send your first pull request. (Read more about the Open JS Foundation CLA process at <https://cla.openjsf.org/>.)
147
143
144
+
The pull request title is autogenerated from the summary of the first commit, but it can be edited before the pull request is submitted.
145
+
146
+
The description of a pull request should explain what you did and how its effects can be seen.
147
+
148
+
When a pull request is merged, its commits will be squashed into one single commit. The first line of the squashed commit message will contain the title of the pull request and the pull request number.
149
+
The pull request title format is important because the titles are used to create a changelog for each release. The tag and the issue number help to create more consistent and useful changelogs.
150
+
148
151
## Following Up
149
152
150
153
Once your pull request is sent, it's time for the team to review it. As such, please make sure to:
151
154
152
-
1. Monitor the status of the Travis CI build for your pull request. If it fails, please investigate why. We cannot merge pull requests that fail Travis for any reason.
155
+
1. Monitor the status of the GitHub Actions CI build for your pull request. If it fails, please investigate why. We cannot merge pull requests that fail the CI build for any reason.
153
156
1. Respond to comments left on the pull request from team members. Remember, we want to help you land your code, so please be receptive to our feedback.
154
157
1. We may ask you to make changes, rebase, or squash your commits.
155
158
156
-
### Updating the Commit Message
157
-
158
-
If your commit message is in the incorrect format, you'll be asked to update it. You can do so via:
159
-
160
-
```shell
161
-
git commit --amend
162
-
```
163
-
164
-
This will open up your editor so you can make changes. After that, you'll need to do a forced push to your branch:
159
+
### Updating the Pull Request Title
165
160
166
-
```shell
167
-
git push origin issue1234 -f
168
-
```
161
+
If your pull request title is in the incorrect format, you'll be asked to update it. You can do so via the GitHub user interface.
0 commit comments