Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NMIND certif #575

Open
22 of 42 tasks
Remi-Gau opened this issue Jun 5, 2023 · 0 comments
Open
22 of 42 tasks

NMIND certif #575

Remi-Gau opened this issue Jun 5, 2023 · 0 comments

Comments

@Remi-Gau
Copy link
Collaborator

Remi-Gau commented Jun 5, 2023 •
edited
Loading

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

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

documentation

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

NMIND silver certif

testing

  • Some form of testing suite present
  • Test coverage > 50%

infrastructure

  • Issue template(s) available
  • Continuous integration runs tests
  • No excessive files included

documentation

  • Background/significance of program
  • 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
  • Continuous integration validates style
  • Journal of Open Source Software submission
  • Contribution guide present
  • Code of Conduct present

documentation

  • Continuous integration badges in README for build status
  • Continuous integration badges in README for tests passing
  • Continuous integration badges in README for coverage
  • Document functions, classes, modules, etc.
  • Has a documented style guide
  • Maintenance status is documented
@Remi-Gau Remi-Gau added this to the v0.2.0 milestone Jun 17, 2023
@Remi-Gau Remi-Gau removed this from the v0.2.0 milestone Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Remi-Gau