migrate template changes to new template structure

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,10 @@
-# Title <- provide a title for the PR
-
-*Please don't delete any sections when completing this PR template; instead enter **N/A** for checkboxes or sections which are not applicable, unless otherwise stated below*
+* Issue: [enter link to issue here]
 
-See # <- enter link to issue on main board
+---
 
-Describe the scope/purpose of the PR here in as much detail as you like
+# Title <- provide a title for the PR
 
-## Categorisation
+*briefly describe the PR here*
 
 This PR...
 - [ ] has scripts to run
@@ -18,121 +16,52 @@ This PR...
 - [ ] affects the publisher area
 - [ ] affects the monitoring
 
-## Basic PR Checklist
-
-Instructions for developers:
-* For each checklist item, if it is N/A to your PR check the N/A box
-* For each item that you have done and confirmed for yourself, check Developer box (including if you have checked the N/A box)
-
-Instructions for reviewers:
-* For each checklist item that has been confirmed by the Developer, check the Reviewer box if you agree
-* For multiple reviewers, feel free to add your own checkbox with your github username next to it if that helps with review tracking
-
-### Code Style
-
-- No deprecated methods are used
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- No magic strings/numbers - all strings are in `constants` or `messages` files
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- ES queries are wrapped in a Query object rather than inlined in the code
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Where possible our common library functions have been used (e.g. dates manipulated via `dates`)
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Cleaned up commented out code, etc
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Urls are constructed with `url_for` not hard-coded
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-### Testing
-
-- Unit tests have been added/modified
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Functional tests have been added/modified
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Code has been run manually in development, and functional tests followed locally
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Have CSS/style changes been implemented?  If they are of a global scope (e.g. on base HTML elements) have the downstream impacts of the change in other areas of the system been considered?
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-### Documentation
-
-- FeatureMap annotations have been added
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Documentation updates - if needed - have been identified and prepared for inclusion into main documentation (e.g. added and highlighted/commented as appropriate to this PR)
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Core model documentation has been added to if needed: https://docs.google.com/spreadsheets/d/1lun2S9vwGbyfy3WjIjgXBm05D-3wWDZ4bp8xiIYfImM/edit
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Events and consumers documentation has been added if needed: https://docs.google.com/spreadsheets/d/1oIeG5vg-blm2MZCE-7YhwulUlSz6TOUeY8jAftdP9JE/edit
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- The docs for this branch have been generated and pushed to the doc site (see docs/README.md for details)
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-
-### Release Readiness
-
-- If needed, migration has been created and tested locally
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- Release sheet has been created, and completed as far as is possible https://docs.google.com/spreadsheets/d/1Bqx23J1MwXzjrmAygbqlU3YHxN1Wf7zkkRv14eTVLZQ/edit
-  - [ ] N/A
-  - [ ] Developer
-  - [ ] Reviewer
-
-- There has been a recent merge up from `develop` (or other base branch).  List the dates of the merges up from develop below
-  - [date of merge up]
-
+## Developer Checklist
+
+*Developers should review and confirm each of these items before requesting review*
+
+* [ ] Code meets acceptance criteria from issue
+* [ ] Unit tests are written and all pass
+* [ ] User Test Scripts (if required) are written and have been run through
+* [ ] Project's coding standards are met
+    - No deprecated methods are used
+    - No magic strings/numbers - all strings are in `constants` or `messages` files
+    - ES queries are wrapped in a Query object rather than inlined in the code
+    - Where possible our common library functions have been used (e.g. dates manipulated via `dates`)
+    - Cleaned up commented out code, etc
+    - Urls are constructed with `url_for` not hard-coded
+* [ ] Code documentation and related non-code documentation has all been updated
+    - Core model documentation has been added to if needed: https://docs.google.com/spreadsheets/d/1lun2S9vwGbyfy3WjIjgXBm05D-3wWDZ4bp8xiIYfImM/edit
+    - Events and consumers documentation has been added if needed: https://docs.google.com/spreadsheets/d/1oIeG5vg-blm2MZCE-7YhwulUlSz6TOUeY8jAftdP9JE/edit
+* [ ] Migation has been created and tested
+* [ ] There is a recent merge from `develop`
+
+## Reviewer Checklist
+
+*Reviewers should review and confirm each of these items before approval*
+*If there are multiple reviewers, this section should be duplicated for each reviewer*
+
+* [ ] Code meets acceptance criteria from issue
+* [ ] Unit tests are written and all pass
+* [ ] User Test Scripts (if required) are written and have been run through
+* [ ] Project's coding standards are met
+    - No deprecated methods are used
+    - No magic strings/numbers - all strings are in `constants` or `messages` files
+    - ES queries are wrapped in a Query object rather than inlined in the code
+    - Where possible our common library functions have been used (e.g. dates manipulated via `dates`)
+    - Cleaned up commented out code, etc
+    - Urls are constructed with `url_for` not hard-coded
+* [ ] Code documentation and related non-code documentation has all been updated
+    - Core model documentation has been added to if needed: https://docs.google.com/spreadsheets/d/1lun2S9vwGbyfy3WjIjgXBm05D-3wWDZ4bp8xiIYfImM/edit
+    - Events and consumers documentation has been added if needed: https://docs.google.com/spreadsheets/d/1oIeG5vg-blm2MZCE-7YhwulUlSz6TOUeY8jAftdP9JE/edit
+* [ ] Migation has been created and tested
+* [ ] There is a recent merge from `develop`
 
 ## Testing
 
-List the Functional Tests that must be run to confirm this feature
-
-1. ...
-2. ...
-
+*List user test scripts that need to be run*
 
+*List any non-unit test scripts that need to be run by reviewers*
 
 ## Deployment
 
@@ -161,5 +90,3 @@ What new infrastructure does this PR require (e.g. new services that need to run
 ### Continuous Integration
 
 What CI changes are required for this
-
-

cms/README.md

@@ -177,19 +177,19 @@ frontmatter directives, then you can also import the template directly at any po
 
 This is done by wrapping a template import directive in an HTML `<div>` tag (to prevent the markdown
 interpreter from touching it).  This is done as follows.  Ensure that the import directive is formatted
-exactly as specified here.  You should just change the path to the template file (`data/sponsors.html`)
+exactly as specified here.  You should just change the path to the template file (`public/includes/_sponsors.html`)
 to the appropriate path for the template you wish to include:
 
 ```
-<div>{% include "data/sponsors.html" %}</div>
+<div>{% include "public/includes/_sponsors.html" %}</div>
 ```
 
 For example, to import a data template in the middle of some text:
 
 ```
 Here is some introductory text about the following data...
 
-<div>{% include "data/sponsors.html" %}</div>
+<div>{% include "public/includes/_sponsors.html" %}</div>
 
 Wasn't that data interesting?
 ```