This repo contains checklists for bronze, silver, and gold tiers of NMIND standards.
These checklists are encoded in JSON in checklists/checklist.json and rendered human-readable at nmind.org/standards-checklist.
- Being able to cite the software in grant applications and publications! (DOI)
- Reasonable degree of certainty other will be able to install and use your code!
- All benefits of bronze plus...
- Accessibility across a range of user experience.
- Greater portability of code (with containers) makes it more available to users, increasing the likelihood of your tool being used.
- Greater stability during development due to tests constantly checking code.
- All benefits of silver plus...
- A greater sense of community guidelines, attracting contributors.
- Extensive documentation assists users with more advanced use cases.
- JoSS will increase the visibility of your project!
The file checklists/checklist.json contains the description
of the bronze, silver and gold tier checklists, which
are rendered by the application in interactive/.
For example, this snippet:
{
"id": "bronze_doc_1",
"prompt": "Landing page (e.g., GitHub README, website) provides a link to documentation and brief description of what program does",
"tier": "bronze",
"section": "documentation",
"type": "checkbox"
},renders under the Bronze heading as the checklist item:
- Landing page (e.g., GitHub README, website) provides a link to documentation and brief description of what program does
The workflow to add a new tool to the proceedings page is as follows:
flowchart LR
A(User checklist submission) --> B(Github Issue)
B --> C(Checklist review)
C --> D{Approved?}
D -->|No| E(Revision)
E --> C
D -->|Yes| F(Added to proceedings)
- User submits checklist from the web app
- An issue is created from submitted checklist
- Review process with NMIND moderator via created issue
- When approved (addition of
approvedlabel), user submission is added to the checklist via CI.
Inspired by the original hackmd document.