Develop a spec release protocol

biocompute-objects / BCO_Documentation

Repository for documentation to support the IEEE 2791-2020 standard. Please see our home page for communications/publications:

http://biocomputeobject.org/

BSD 3-Clause "New" or "Revised" License

16 stars 12 forks source link

Closed HadleyKing closed 2 years ago

HadleyKing commented 5 years ago

We need to develop a spec release protocol so we can update in an orderly fashion. A few suggestions for what it should contain to start:

method explained for versioning based on Semantic Versioning and utilizing Permanent Identifiers for the Web
Method for issue triage, I.E. how are issues/suggestions handled? What about ideas for future development or implementation?

Also, where should these policies be stated? In the README, in a new user guide, or in a new document?

nsoranzo commented 5 years ago

I'd suggest to state this in a different document, not the main README.

HadleyKing commented 5 years ago

@nsoranzo
Looking at the Galaxy releases it seems that the doc lists each commit incorporated? is that automatic?

nsoranzo commented 5 years ago

Yep, the release notes are generated by the scripts/bootstrap_history.py script, invoked via make release-bootstrap-history