Skip to content

Commit 781e52b

Browse files
Update structure.md
1 parent 2e43b9e commit 781e52b

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

cheatsheets/github/structure.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Create a file with this path like one of these:
147147
- `docs/pull_request_template.md`
148148
- `.github/pull_request_template.md`
149149

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.
151151

152152
Or create a directory with a named file:
153153

@@ -161,8 +161,40 @@ For the content:
161161
> - A description of the changes proposed in the pull request.
162162
> - @mentions of the person or team responsible for reviewing proposed changes.
163163
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
188+
189+
- Is the AC being met?
190+
- Are there odd behaviors?
191+
- Are all necessary tests present?
192+
```
193+
164194

165195
## Contributing doc
166196

197+
Create as either:
198+
167199
- `CONTRIBUTING.md`
168200
- `docs/CONTRIBUTING.md`

0 commit comments

Comments
 (0)