Skip to content

Commit 98cecb5

Browse files
committed
Update PR template
1 parent db1997a commit 98cecb5

1 file changed

Lines changed: 4 additions & 38 deletions

File tree

.github/pull_request_template.md

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,12 @@
1-
Optional preview: after opening the PR, comment `/preview` to publish a public preview and `/unpreview` to remove it. The workflow will reply with the preview URL. Please check for secrets before publishing a preview.
2-
3-
This template includes 3 checklists, only 1 of which is needed for your PR. Please **delete as appropriate** before submitting the PR.
4-
5-
For _Papers of the Month_, there are two types of PR:
6-
7-
1. **Summary PRs:** individual paper summaries on their own branch (`pom-YYYY-MM-<short-name-of-paper>`), to be merged into monthly branch.
8-
2. **Monthly PRs:** a group of paper summaries on a monthly branch (`pom-YYYY-MM`), to be merged into `main`.
9-
10-
---
11-
12-
## Summary PR Checklist
13-
14-
Authors should make an effort to satisfy these criteria, but it is the _editor's job_ to tick them off before accepting the PR (anything that requires the page to be rendered can be left to the editor).
15-
16-
- [ ] Check PR is set to merge into branch `pom-YYYY-MM`, **not** `main`
17-
- [ ] Check paper author names look reasonable
18-
- [ ] Check summary author names
19-
- [ ] Check other frontmatter (content at top of page)
20-
- [ ] Check paper links actually go to paper
21-
- [ ] Check tags are aligned with existing tags at https://graphcore-research.github.io/tags/
22-
- [ ] Check for image alt text
23-
- [ ] Check plots are high-enough resolution
24-
- [ ] Check plots look the right size and scale properly by resizing window; if not, use `![Alt text](my_image.png){:.img-medium}`, or `.img-tiny .img-small .img-large` from `assets/custom.css`, or set a specific size with `{:style="max-width: Xpx;"}`.
25-
- [ ] Review contents of article
26-
- [ ] Spellcheck
1+
...
272

283
---
294

30-
## Monthly PR Checklist
31-
32-
- [ ] Implement chosen ordering of papers
33-
- [ ] Add title to frontmatter
34-
- [ ] Write intro blurb
35-
- [ ] Quickly double-check Summary PR criteria look like they're still satisfied
36-
- [ ] Make sure it looks ok on a local server with `./dev.sh`
37-
- [ ] Double check nothing sensitive has been mentioned
38-
39-
---
5+
_Note: after opening the PR, comment `/preview` to publish a public preview and `/unpreview` to remove it. The workflow will reply with the preview URL. Please check for secrets before publishing a preview._
406

41-
## Blog Post Checklist
7+
## Blog Post Checklist (delete if not required)
428

43-
- [ ] (Author) make sure it looks ok on a local server with `./dev.sh`
9+
- [ ] Make sure it looks ok on a local server with `./dev.sh` OR preview with `/preview` and check the URL in the PR comment; remember to `/unpreview` when done
4410
- [ ] Check required frontmatter, including `slug`
4511
- [ ] Check tags are aligned with existing tags at https://graphcore-research.github.io/tags/
4612
- [ ] Check for image alt text

0 commit comments

Comments
 (0)