Conversation
hayescr
left a comment
There was a problem hiding this comment.
@york-stsci I left a few comments (feel free to take or leave them). The only other question I had, was if there were any recommendations for what to do if there are multiple new features that need to be tested on observations. I'm not sure if such a case happens, but I thought I'd check.
| 2. Immediately commit and push the changes, and create a pull request to add them to main. | ||
| 3. Once the PR has been approved, merge it and then delete the branch. |
There was a problem hiding this comment.
Would it be worth adding some simple git instructions to this like in the above section (I'm not sure how familiar the users are with git, but reminder's never hurt).
There was a problem hiding this comment.
Good thought! I added a quick set of GitHub references at the bottom.
| - If you are making other changes to the repository, remember to update the working | ||
| branch so it has those changes added. |
There was a problem hiding this comment.
Some recommended instructions here might be useful too, for ease of adoption.
RELEASE_PROCEDURE.rst
Outdated
| In this case, we want to make sure the changes are understandable, and we want to make | ||
| sure that they are added to the WS before the next observations are taken. | ||
|
|
||
| 1. Create a new branch on the repository. For the branch name, _describe the specific |
There was a problem hiding this comment.
I took a look at the formatted rst version of this (https://github.com/mrobberto/SAMOS_NEWGUI/blob/upgrade_add_release_procedure/RELEASE_PROCEDURE.rst#id3) and I'm not sure that these _text_ formats are rendering quite right. I'm assuming that they were supposed to be underlines or other emphasis formatting, but it seems to want to format only these as references?
There was a problem hiding this comment.
Of course. Sometimes rst is markdown, sometimes not. Fixed I think.
hayescr
left a comment
There was a problem hiding this comment.
The changes look good to me, thanks @york-stsci !
This PR adds a file describing the SAMOS release procedures and code change procedures, intended to make sure that the repository is consistent and that the WS code and repo code are matching.