microbiomedata / nmdc_notebooks

Jupyter Notebooks demonstrating R and Python-based access to NMDC metadata and data
Creative Commons Zero v1.0 Universal
5 stars 0 forks source link

Add Git Versioning Docs #51

Closed brynnz22 closed 4 months ago

brynnz22 commented 5 months ago

Issue #37

This PR includes the documentation for releases. I am guessing this will be a first go at it and we will do releases, see how we like it, adjust and iterate. I set the release cycle as every first business day of the month if there are changes to main. We can change this how we like. For now, the CHANGELOG.md is manual. There are potential tools we can use to automate this, but I'm not sure that level of automation is necessary given the nature of this repo. The release part of Github auto-generates a description of the release anyway based on the merged requests. Right now I just include an outline in the CHANGELOG. We will have to update/erase some of it with our first release.

All Submissions:

New Notebook Submissions:

Notebook Fix Submissions:

brynnz22 commented 5 months ago

From Bea: Maybe make release date two weeks after nmdc-schema release to apply any new schema changes and keep in sync with new schema changes.

brynnz22 commented 4 months ago

@bmeluch I changed the release dates to be within two weeks of an nmdc-schema release if there are changes to this repo.

@kheal I edited to make caps and periods consistent. And added the changes for the first release v1.0.0. After this is merged in, I will create a release. I can move the guidelines - let me know where you would like.