Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 5.76 KB

README.md

File metadata and controls

64 lines (50 loc) · 5.76 KB

Badges

fair-software.nl recommendations Example Badges
1. Code Repository GitHub URL
  GitHub
2. License License
  License
3. Community Registry Research Software Directory
  PyPI
  bintray
4. Enable Citation DOI
5. Code Quality Checklist cii best practices
Other Badge
Continuous Integration Build Status
  Build status
Code Analysis CodeClimate
  Codacy Badge
  SonarCloud
Code Coverage codecov
  SonarCloud
  Scrutinizer
  Coveralls
  CodeClimate
Documentation ReadTheDocs

(Customize these badges with your own links. Check https://shields.io/ to see which badges are available.)

Welcome

The repository https://github.com/NLeSC/template contains the template for software projects at the Netherlands eScience Center. In principle, it follows the general recommendations from https://fair-software.nl for developing research software, while adding details that are specific to the Netherlands eScience Center.

When starting a new project, look for GitHub's prompt to use the template as a starting point.

The template comes with the 5 recommendations from fair-software.nl predefined as GitHub issues. You'll see them as soon as you click New issue. For each one, click Get started to instantiate the issue from the issue template.

Once you have the 5 recommendations as issues in your issue list, feel free to delete

Documentation for users

  • description of what the software does
  • notes on how to install

Documentation for developers

  • notes on how to contribute

Documentation for maintainers

  • notes on how to make a release