Release

  • Which and how many artefacts are produced from your project’s codebase?
  • Onto which repositories (e.g. PyPI, Docker Hub, GitHub Packages, NPM etc.) are they released? Why?
  • How are they released (e.g. manually, automatically, etc.)?
    • report the configuration steps and commands to run to release the artefacts

Choice of the license

  • Which license did you choose for your artefacts? Why?
  • Which license did you choose for your code? Why?

Choice of the versioning schema

  • Which versioning schema (e.g. date-based versioning, SemVer, etc.) did you choose for your artefacts? Why?
    • how does the versioning schema work?
  • In case of multiple artefacts, are the version numbers aligned or each artefact has its own versioning pace? Why?

  • Describe when and how to create a new version of the artefacts in your project
    • e.g. when to increment the major, minor, and patch version numbers
    • e.g. how to create a new release branch
    • e.g. how to create a new tag
    • e.g. how to create a new release on GitHub