Skip to content

Set out versioning and updates guidance #312

Description

@jatkinson1000

With the publication in JOSS we made our first release v1.0.0

We should discuss how we now want to proceed with releases.

My preference would be selecting appropriate points and adding a tag+release rather than automating anything to bump at every commit to main.

Suggestion would be:

  • Add guidance of versioning to docs
    • major for API changes, minor for periodic releases of new features, patch for bugfixes following https://semver.org/
  • Create a changelog following https://keepachangelog.com/en/1.0.0/ that users/maintainers should update as appropriate with each pull request

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions