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
Copy file name to clipboardExpand all lines: cheatsheets/github/structure.md
+33-1Lines changed: 33 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -147,7 +147,7 @@ Create a file with this path like one of these:
147
147
-`docs/pull_request_template.md`
148
148
-`.github/pull_request_template.md`
149
149
150
-
Note that lowercase looks like the preferred style.
150
+
Note that lowercase looks like the preferred style. But you could do `PULL_REQUEST_TEMPLATE.md` at the root and it will work.
151
151
152
152
Or create a directory with a named file:
153
153
@@ -161,8 +161,40 @@ For the content:
161
161
> - A description of the changes proposed in the pull request.
162
162
> -@mentions of the person or team responsible for reviewing proposed changes.
163
163
164
+
For example. Include exactly as it here with comments. The PR creator must then edit the messsage that is generated. Of course replace the username at the top with a maintainer's name.
165
+
166
+
```markdown
167
+
@MichaelCurrin
168
+
169
+
170
+
## Description
171
+
172
+
<!-- Add details -->
173
+
174
+
175
+
## Issues
176
+
177
+
<!-- Link to an issue if there is one. -->
178
+
<!-- closes #1 -->
179
+
180
+
181
+
<!-- Please also add labels to the PR using Github's labelling e.g. enhancement, bug, translation
182
+
```
183
+
184
+
Or questions to be answered.
185
+
186
+
```markdown
187
+
As part of the code review process please run branch locally and review
0 commit comments