Markdown Rubrics

This page contains Markdown snippets of the suggested review rubrics. The markdown will render nicely on Gitlab, so reviewers may wish to copy these snippets into the comment threads of the associated reviews. See the how-to section for instructions on filling out the snippets.

Security Review

- [ ] No PII
- [ ] No usernames or passwords
- [ ] No absolute file paths
- [ ] No internal server names
- [ ] No internal IP addresses

Code Review

Reference Code

             | Best | Okay | Unacceptable
------------ | :--: | :--: | :----------:
Purpose      |      |      |
Environment  |      |      |
Instructions |      |      |
Clarity      |      |      |
Cruft        |      |      |

Software Tools

Documentation | Best | Okay | Unacceptable
------------- | :--: | :--: | :----------:
Installation  |      |      |
API           |      |      |
Narrative     |      |      |

Quality        | Best | Okay | Unacceptable
-------------- | :--: | :--: | :----------:
Clarity        |      |      |
Modularity     |      |      |
Tests          |      |      |
Test Coverage  |      |      |
Unused Code    |      |      |
Secure / Clean |      |      |

Domain Review

Reference Code

       | Pass | Fail
------ | :--: | :--:
Output |      |

Software Tools

                  | Pass | Fail
----------------- | :--: | :--:
Scope             |      |
Theory: Described |      |
Theory: Validity  |      |
Functionality     |      |

Administrative Review

- [ ] README named "README.md"
- [ ] README written in Markdown
- [ ] README contains summary, purpose, or abstract
- [ ] README contains suggested citation
- [ ] License named "LICENSE.md"
- [ ] License is open source
- [ ] Disclaimer named "DISCLAIMER.md"
- [ ] Disclaimer contains approved FSP text
- [ ] Commit history is secure
- [ ] code.json at the top level
- [ ] code.json is formatted correctly

How to Edit

The security and administrative review snippets are formatted as checklists:

- [ ] Item 1
- [ ] Item 2
- [ ] Item 3

You can check an item by placing an X in the relevant box. For example, the following markup:

- [X] Item 1
- [ ] Item 2
- [X] Item 3

would mark items 1 and 3 as complete.

By contrast, the code and domain review snippets are formatted as tables:

       |  Pass  |  Fail
------ | :----: | :----:
Item 1 |        |
Item 2 |        |

You can check an item by placing an X in the relevant box on its row. For example:

       | Pass | Fail
------ | :--: | :--:
Item 1 |  X   |
Item 2 |      |   X

would mark item 1 as passing, and item 2 as failing. Alternatively, you can leave comments in the boxes. For example:

       | Pass | Fail
------ | :--: | :--:
Item 1 |  Here are some thoughts on item 1.   |
Item 2 |      |   Here is why item 2 failed the review.

Note that it’s alright to break the alignment of the | pipes when leaving comments.