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

adhere to NLeSC software checklist #23

Open
13 of 45 tasks
bakhshir opened this issue Sep 21, 2017 · 0 comments
Open
13 of 45 tasks

adhere to NLeSC software checklist #23

bakhshir opened this issue Sep 21, 2017 · 0 comments

Comments

@bakhshir
Copy link
Contributor

bakhshir commented Sep 21, 2017 •
edited

Version control

  • version control from the beginning of the project
  • use git as version control system (vcs)
  • choose one branching model
  • public vcs repository
  • meaningful commit messages need to work on this

Releases

  • semantic versioning
  • tagged releases
  • CHANGELOG.md
  • one command install
  • package in package manager
  • discuss release cycle with coordinator
  • release quick-scan by other engineer
  • Citeable
  • Dissemination

Licensing

  • Apache 2 license
  • compatible license of all libraries
  • NOTICE(.txt|.md)

Communication

  • home page
  • discussion list
  • demo docker image in dockerhub (with Dockerfile)
  • an online demo
  • screencast

Code Quality

  • use editorconfig
  • code style applied in automated way

Testing

  • unit tests
  • continuous integration
  • continuous code coverage
  • end2end test
  • dependencies tracking

Documentation

  • README.md
  • well defined functionality
  • source code documentation
  • usage documentation
  • documented development setup
  • contribution guidelines
  • code of conduct
  • documented code style
  • how to file a bug report
  • explained meaning of issue labels
  • DOI or PID
  • CITATION file
  • print software version

Development setup

  • dev environment docker images in Dockerhub (with Dockerfile)

Standards

  • Exchange formats
  • Protocols

NOTE: we can check master branch of TNO CS repo for missing components of our repo
see https://github.com/TNOCS/csWeb/

More comment in checklist.txt
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
@bakhshir