search

spacetelescope / style-guides

An opinionated guide on how we work.
Creative Commons Attribution 4.0 International
55 stars 33 forks source link

Software versioning guide #27

Closed eteq closed 6 years ago

eteq commented 6 years ago

This should close #13 by providing a fairly comprehensive guide on version management. It has a particularly length section on Python, which is also now referenced from the Python guide (but not added to the Python guide itself, as the level of detail here seemed a bit mis-matched from the intent in the the Python guide)

cc @stscicrawford

eteq commented 6 years ago

Oh and this raises one question: are we ok referencing confluence documents from here? (In this case it's the software version policy.) I figured it's reasonable so included it, but not sure if we've discussed yet @arfon @stscicrawford ?

stscicrawford commented 6 years ago

Yes it is okay. The relevant information should be included in the document, but linking back to the policy or other confluence page is strongly recommended. Right now the audience would be people that are working at STScI and so they would have access to the policy.

stscicrawford commented 6 years ago

Looks great and I'll open an issue with the comment about updating this to have more direct recommendations and more detailed discussion to be saved for supporting documents.