How to commit #413
How to commit #413
Conversation
source/Reviewers/howtocommit.rst
Outdated
| fcm cf | ||
|
|
||
| .. tab-item:: LFRic Apps | ||
| 1. Merge in main and Clone Branch |
There was a problem hiding this comment.
| 1. Merge in main and Clone Branch | |
| .. important :: | |
| All changes made by the reviewer (e.g. for upgrade macros, KGOs or linked tickets) will be committed to the developers branch in their fork. All testing should be run on this branch too. Once this is all complete the GitHub can complete the merge of this branch to ``main``. | |
| 1. Merge in main and Clone Branch |
I think we need something like this at the start to make it clear what the overall process is. I'm unsure if this wants putting as part of the opening paragraph or in a box or something else?
|
|
||
| Now commit the changes made by the macros script back to the developers branch. | ||
|
|
||
| Do not push the changes at this stage. |
There was a problem hiding this comment.
Does pushing or not matter here?
There was a problem hiding this comment.
I think I was trying to cover for times when the testing failed. If the developer needs to make fixes then it'd be easier to not have pushed the macro changes back to the github repo?
| 4. Once the ticket is back with you, you can merge the branch to the | ||
| trunk and run the test-suite as described above to confirm that all | ||
| is working. | ||
| Do not push the changes at this stage. |
There was a problem hiding this comment.
again - why not push?
There was a problem hiding this comment.
Yeah same as above - probably not as important for kgo changes as macro changes.
|
|
||
| .. code-block:: RST | ||
| Once the remote branch has been updated, the pull request continuous integration |
There was a problem hiding this comment.
ah - is the not pushing bit to not trigger the CI too many times?
There was a problem hiding this comment.
That is a bonus as well I guess!
There was a problem hiding this comment.
Thanks Jenny. Agree with all suggestions (I need to do the 1st manually as it can't do 2 on the same line)
We'll definitely need to come back to these pages, particularly as the test suite process becomes firmer. We'll need to update rose stem commands everywhere
|
|
||
| Now commit the changes made by the macros script back to the developers branch. | ||
|
|
||
| Do not push the changes at this stage. |
There was a problem hiding this comment.
I think I was trying to cover for times when the testing failed. If the developer needs to make fixes then it'd be easier to not have pushed the macro changes back to the github repo?
| 4. Once the ticket is back with you, you can merge the branch to the | ||
| trunk and run the test-suite as described above to confirm that all | ||
| is working. | ||
| Do not push the changes at this stage. |
There was a problem hiding this comment.
Yeah same as above - probably not as important for kgo changes as macro changes.
|
|
||
| .. code-block:: RST | ||
| Once the remote branch has been updated, the pull request continuous integration |
There was a problem hiding this comment.
That is a bonus as well I guess!
Co-authored-by: Jenny Hickson <61183013+jennyhickson@users.noreply.github.com>
This changes the instructions for committing tickets from trac world to prs in github. It also adds instructions for reversing a commit. There are still quite a few details to update when we know what they should be, particularly around launching test suites, but I think it's probably a reasonable point to get these changes merged.