Add Maintainer Version Update process description to wiki#2840
Add Maintainer Version Update process description to wiki#2840KFosterReed wants to merge 5 commits intodevfrom
Conversation
KFosterReed
requested review from
JoeWaddell,
JuanTricarico,
LisaM-kiwi and
PooyaHekmati
|
Current Coverage: 99% Mypy errors on Maintainer-Version-Update-Process branch: 1420 |
|
🚨 Please update the changelog. This PR cannot be merged until |
LisaM-kiwi
left a comment
LisaM-kiwi
left a comment
There was a problem hiding this comment.
This looks good to me!
Updated wording for clarity and consistency in the version update workflow documentation.
|
Current Coverage: 99% Mypy errors on Maintainer-Version-Update-Process branch: 1191 |
1 similar comment
|
Current Coverage: 99% Mypy errors on Maintainer-Version-Update-Process branch: 1191 |
JoeWaddell
left a comment
JoeWaddell
left a comment
There was a problem hiding this comment.
This looks great, pending a couple questions! Hits the right amount of detail for me, as it works as a good set of guidelines without being too restrictive.
Also, it now works well with #2813, and I think the code there can link to or otherwise reference this writeup.
| 2. The PML reviews and approves pending work to be included and excluded | ||
| from the version update, with additional Maintainer input as needed. | ||
|
|
||
| 3. The PML and team leaders create a GitProject for the version release and |
There was a problem hiding this comment.
Should this project be Public, or Private to maintainers?
There was a problem hiding this comment.
I lean towards making it public so that people can easily see what is coming in the next version update.
There was a problem hiding this comment.
I agree I think leaving it as a public project makes sense
| - [2925](https://github.com/RuminantFarmSystems/RuFaS/pull/2925) - [minor change] [NoInputChange] [NoOutputChange] Fix the `graph_and_report` option in report_generation.py. | ||
| - [2907](https://github.com/RuminantFarmSystems/RuFaS/pull/2907) - [minor change] [NoInputChange] [OutputChange] Fix the FarmGrownFeed Emissions unit issue. The mirror issue of [Fix FarmGrownFeed Emissions Unit on test #2908](https://github.com/RuminantFarmSystems/MASM/pull/2908) to update `dev`. | ||
| - [2934](https://github.com/RuminantFarmSystems/RuFaS/pull/2934) - [minor change] [NoInputChange] [NoOutputChange] [Animal][Reproduction] Refactor `Reproduction.execute_cow_ed_protocol()`. | ||
| - [2840](https://github.com/RuminantFarmSystems/RuFaS/pull/2840) - [minor change] [Docs] [NoInputChange] [NoOutputChange] Adds page documenting workflow to acheive version update. |
There was a problem hiding this comment.
| - [2840](https://github.com/RuminantFarmSystems/RuFaS/pull/2840) - [minor change] [Docs] [NoInputChange] [NoOutputChange] Adds page documenting workflow to acheive version update. | |
| - [2840](https://github.com/RuminantFarmSystems/RuFaS/pull/2840) - [minor change] [Docs] [NoInputChange] [NoOutputChange] Adds page documenting workflow to achieve version update. |
|
|
||
| After ``test`` is updated | ||
| ------------------------- | ||
| - During the testing phase, SME Maintainers will evaluate integrated model performance. (link to Scientific Evaluation Process). |
There was a problem hiding this comment.
reminder that link needed here! Or to add the Issue number while it's still in progress
| - During the testing phase, SME Maintainers will evaluate integrated model performance. (link to Scientific Evaluation Process). | ||
| - When the model performance has been verified by at least one SME Maintainer per Module, the Scientific Director will prepare a Scientific Report summarizing the model performance and changes in scientific methodology. | ||
| - The Director of Software Engineering will lead preparation of a set of Release Notes to summarize model updates. | ||
| - When the testing phase is complete, both the Scientific Report and Release notes are added to the project documentation on GitHub and shared with the PML for approval. |
There was a problem hiding this comment.
Should it be made explicit here how/how quickly test->main happens after this? Or should the text here simply link to what's contained in #2813?
There was a problem hiding this comment.
My thought was that this statement connects to point 3 in the "Merging to main" section that Branching Strategy PR. I don't think we need a specific timeline although part of me definitely wants one
3 participants
Context
Issue(s) closed by this pull request: closes #2796
This PR adds the process developed through discussion in issue #2796 into a wiki page to document the process for reference in the future.
Note that when issue #2818 is complete, the references to the SME Review process on this page should be linked to that page