Versioning and release version guide

[hlapp]

This may be useful to add, at least as largely a collection of references and links.

[egrace479]

Certainly the GitHub-PyPI-Zenodo integrations with CITATION.cff and README updates in schedule:

• Add PyPI publication workflow:*
  • Automate publish to pypi on release
  • Keywords in pyproject.toml (no spaces, even within quotes)
• Add/Update citation and Zenodo metadata
  • Add/Update citation file for easier reference with correct version and tag filled (commit hash of version to be filled in after release)
  • DOI should be general software DOI on Zenodo to avoid mis-matched version confusion (since it must be added after release)
  • make sure date is correct
  • set version in about file
  • .zenodo.json: Add/Update JSON file for metadata tracking with Zenodo and test to validate it
  • Keywords in all these files
• Update installation to reflect imminent release and PyPI publication*
  • pip install <package-name> instead of GitHub URL
• Release updates
  • Add DOI badge to README (make sure it's general DOI, not version-specific)*
  • Add PyPI badges to README*
  • Add DOI to CITATION.cff*
  • Add release commit hash to CITATION.cff

*indicates things to be done only once (the first time this is set up)

@thompsonmj, documented our process for adding this to the guide later

[egrace479]

A lot of this was covered in Collab Guide PR24 and PR29. We also have some of this detailed on the project's guidelines which we could potentially use as a basis for such a guide with links to the appropriate sections. Presumably it should go under the GitHub Repo Guide.