Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 1.77 KB

pull_request_template.md

File metadata and controls

35 lines (27 loc) · 1.77 KB

For Papers of the Month summaries, there are two types of PR:

  1. Summary PRs: individual paper summaries on their own branch (pom-YYYY-MM-<short-name-of-paper>), to be merged into monthly branch.
  2. Monthly PRs: a group of paper summaries on a monthly branch (pom-YYYY-MM), to be merged into main.

When creating a PR, please delete this message, leaving the relevant one of the two subsequent sections.

Summary PR Checklist

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

  • Check PR is set to merge into branch pom-YYYY-MM, not main
  • Check paper author names look reasonable
  • Check summary author names
  • Check other front matter (content at top of page)
  • Check paper links actually go to paper
  • Check tags are aligned with existing tags at https://graphcore-research.github.io/tags/
  • Check for image alt text
  • Check plots are high-enough resolution
  • Check plots width-scale properly by resizing window / general mobile rendering (if not, use .constrained_img css classes in assets/css/main.scss)
  • Review contents of article
  • Spellcheck

Monthly PR Checklist

  • Implement chosen ordering of papers
  • Add title do front matter & file name
  • Write intro blurb
  • Add twitter card image to /assets/images/posts/YYYY-MM/potm/twitter_card.png
  • Quickly double-check Summary PR criteria look like they're still satisfied
  • Check date in footer
  • Make sure it looks ok on temporary version of public mirror, at https://graphcore-research.github.io/graphcore-research.github.io-internal/
  • Double check nothing sensitive has been mentioned