Giter VIP home page Giter VIP logo

siga's People

Contributors

arnikz avatar bakhshir avatar jspaaks avatar sverhoeven avatar

Watchers

 avatar  avatar

Forkers

gurnoor1990

siga's Issues

adhere to NLeSC software checklist

Check if the repo has everything from the software checklist, in preparation for the release:

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

[CLOSED] [doc] cleanup example usage

Issue by bakhshir
Wednesday Mar 22, 2017 at 11:41 GMT
Originally opened as NLeSC/candYgene#7


The example usage section in the markdown does not refer to the proper examples directory.
For instance, python SIGA.py db -rV ITAG2.4_gene_models.gff3 should be python SIGA.py db -rV ../examples/ITAG2.4_gene_models.gff3

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.