-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'remote-database' into remove-literature
- Loading branch information
Showing
1 changed file
with
2 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,3 @@ | ||
|
||
# Adding Literature Checklist (delete if not applicable) | ||
|
||
For contributors and reviewers alike. | ||
|
||
- [ ] Name PR `Add literature_identifier` | ||
|
||
**Filename** | ||
|
||
- [ ] Words and identifiers in the filenames must be lowercase. | ||
- [ ] The filename must be of type `NAME_YEAR_FIRST-WORD_VOLUME_fxy_IDENTIFIER` (where x is the figure number and y the subfigure label, i.e., 2b). | ||
- [ ] The figure number must match that of the figure in the article. | ||
|
||
**Bib file** | ||
|
||
- [ ] The identifier must be identical with that in the filename as well as the citation key in the YAML. | ||
- [ ] Remove typos (or unwanted whitespace), specifically in the title such as `Pt (111)` to `Pt(111)`. | ||
|
||
**SVG** | ||
|
||
- [ ] The curve label should be short and unambiguous? | ||
- [ ] Figure label should be of type `Figure: xy` (not `Figure: fxy`). | ||
- [ ] The figure label must be identical to that in the article. | ||
- [ ] Comments should be complete sentences ending with a period. | ||
- [ ] A `tags` text label should be included in the SVG. | ||
- [ ] The units on the axis should be identical to those n the figure. | ||
|
||
**YAML** | ||
|
||
- [ ] The identifier must be identical to that in the filename. | ||
- [ ] Comments should be complete sentences ending with a period. | ||
- [ ] Add news for the change | ||
- [ ] Adapt documentation |