Effective Github

  • TRL1: project creation, registration, description (README); link to opensource.guide
  • TRL2: specs in docs/specs.md; issue tracker - Github, Trello
  • TRL4: documentation including URL, using Github pages to host documentation site, or alternative Readthedocs; setup a project wiki
  • TRL5: versioning, use Git tags for clear cut releases, leverage Github downloads, Pypi, Maven central, Docker hub to distribute binary releases
  • TRL6: code quality assessment, use static code analysis, code style checks and code linting - Codacy…
  • TRL7: unit tests, continuous integration, use code coverage tools: Travis, CircleCI, Werker
  • TRL8: integration tests
  • TRL9: continuous deployment, web hooks