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.

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

Checklist for Open Source Software #1

Open
7 of 22 tasks
pescini opened this issue Feb 23, 2021 · 0 comments
Open
7 of 22 tasks

Checklist for Open Source Software #1

pescini opened this issue Feb 23, 2021 · 0 comments

Comments

@pescini
Copy link
Collaborator

pescini commented Feb 23, 2021

General checks

  • Repository
    • Software code available on a public repository
  • License
    • A plain-text LICENSE file with the contents of an OSI approved software license
  • Installation
    • List of dependencies
    • Provide the software via a package manager
      • Conda via Bioconda
      • Language specific package manager: Pypi, Bioconductor, etc
    • Installation proceeding as outlined in the documentation
  • Code structure

  • Automated tests
    • Continuous integration with automated tests verifying the functionality of the software
  • Versioning & DOI
    • Connect repository to archiving tool like Zenodo
    • Generate releases often

Documentation

  • README.md
  • Documentation together with the code: GitHub page, ReadTheDoc
  • A statement of need: Section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is
  • Installation instructions: Clearly-stated list of dependencies, installation guideline
  • Example usage: Examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Documentation of the core functionality of the software documented to a satisfactory level (e.g., API method documentation)
  • Performance
  • Community guidelines: Clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support
    • Code of Conduct
    • CONTRIBUTING.md file
    • Roadmap
  • API documentation inside the functions

Credits to @bebatut

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant