[x] The software should be open source as per the OSI definition.
[x] The software should have an obvious research application.
[x] You should be a major contributor to the software you are submitting.
[x] The software should be a significant contribution to the available open source software that either enables some new research challenges to be addressed or makes addressing research challenges significantly better (e.g., faster, easier, simpler).
[ ] The software should be feature-complete (no half-baked solutions) and designed for maintainable extension (not one-off modifications). Minor ‘utility’ packages, including ‘thin’ API clients, and single-function packages are not acceptable
[x] Your paper (paper.md and BibTeX files, plus any figures) must be hosted in a Git-based repository. Placing these items together with your software (rather than in a separate repository) is strongly encouraged.
[x] Be stored in a repository that can be cloned without registration.
[x] Be stored in a repository that is browsable online without registration.
[x] Have an issue tracker that is readable without registration.
[x] Permit individuals to create issues/file tickets against your repository.
Your paper should include:
[x] A list of the authors of the software and their affiliations, using the correct format (see the example below).
[x] A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience.
[x] A clear Statement of Need that illustrates the research purpose of the software.
[x] A list of key references, including to other software addressing related needs.
[x] Mention (if applicable) a representative set of past or ongoing research projects using the software and recent scholarly publications enabled by it.
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Contribution and authorship: Has the submitting author (@devarops) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
[x] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
[x] Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
[x] Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)
Documentation
[ ] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[ ] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[ ] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[ ] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[ ] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
[ ] Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support
Software paper
[ ] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[ ] A statement of need: Does the paper have a section titled 'Statement of need' that clearly states:
[ ] what problems the software is designed to solve,
[ ] who the target audience is, and
[ ] its relation to other work?
[ ] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[ ] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[ ] References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?
Prerequisites
Requirements for JOSS:
Your paper should include:
Reviewer checklist
General checks
Functionality
Documentation
Software paper
Resources