cpp-lln-lab / bidspm

an SPM centric BIDS app

https://bidspm.readthedocs.io/en/latest/general_information.html

GNU General Public License v3.0

5 stars 13 forks source link

NMIND certif #1068

Open Remi-Gau opened 1 year ago

Remi-Gau commented 1 year ago

NMIND bronze certif

testing

[ ] Provide / generate / point to test data
[ ] Provide instructions for users to run tests that include instructions for evaluation for correct behavior

infrastructure

[x] Code is open source
[x] Package is under version control
[x] Readme is present
[x] License is present
[x] Issues tracking is enabled
[x] Digital Object Identifier (DOI) points to latest version
[ ] All documented installation instructions can be successfully followed

documentation

[x] Landing page (e.g., GitHub README, website) provides a link to documentation and brief description of what program does
[x] Documentation is up to date with version of software
[ ] Typical intended usage is described
[ ] An example of its usage is shown
[x] Document functions intended to be used by users
[x] Description of required input parameters for user-facing functions with reasonable description of inputs
[ ] Description of output(s)
[x] User installation instructions available
[x] Dependencies listed

NMIND silver certif

testing

[x] Some form of testing suite present
[x] Test coverage > 50%

infrastructure

[x] Issue template(s) available
[x] Continuous integration runs tests
[x] No excessive files included

documentation

[ ] Background/significance of program
[x] One or more tutorial to showcase the multiple of the program's usages
[ ] Any alternative usage that is advertised is thoroughly documented
[ ] Thorough description of required and optional input parameters
[ ] Document public functions
[ ] A statement of supported operating systems / environments

NMIND gold certif

testing

[ ] Test coverage > 90%
[ ] Benchmarking information is provided for examples

infrastructure

[ ] Continuous integration builds packages
[x] Continuous integration validates style
[ ] Journal of Open Source Software submission
[x] Contribution guide present
[ ] Code of Conduct present

documentation

[x] Continuous integration badges in README for build status
[x] Continuous integration badges in README for tests passing
[x] Continuous integration badges in README for coverage
[ ] Document functions, classes, modules, etc.
[ ] Has a documented style guide
[ ] Maintenance status is documented

github-actions[bot] commented 1 year ago

We found the following entry in the FAQ which you may find helpful:

General: How can I run bidspm only certain files, like just the session 02 for example?

Feel free to close this issue if you found an answer in the FAQ. Otherwise, please give us a little time to review.

This is an automated reply, generated by FAQtory