diff --git a/changelog.md b/changelog.md index 10ab98d822..dc2b0dd39c 100644 --- a/changelog.md +++ b/changelog.md @@ -63,6 +63,7 @@ v1.0.0 - [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. ### v1.0.0 diff --git a/docs/_src/_wiki/Version-Update-Workflow.rst b/docs/_src/_wiki/Version-Update-Workflow.rst new file mode 100644 index 0000000000..c4be27afdb --- /dev/null +++ b/docs/_src/_wiki/Version-Update-Workflow.rst @@ -0,0 +1,52 @@ +Maintainer Team Workflow and Communication during a Version Update +=================================================================== + +This page describes the process that RuFaS Maintainers will use to communicate +and execute a version update. + +In addition to the updated model and scientific documentation in the repository +codebase, additional deliverables of this process for **Major** and **Minor** +updates are: + +- A detailed technical report of the scientific review by SME Maintainers +- A version release note that includes: + - A high-level summary of the outcomes of the SME Review + - A summary of the changelog + + +Before Merging ``dev`` to ``test`` +------------------------------ + +**Major** and **Minor** updates: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +1. RuFaS Maintainers meet to discuss what work **will and will not** be + included in the release and the proposed timeline. + +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 + add pending issues/PRs that must be completed before the version update + (before ``dev → test``). If a Maintainer identifies additional work that would benefit + the version release after the project is created, issues/PRs should be added to + the version release project or discussed with the PML at the members discretion. + +4. SME Maintainers review the scientific evaluation process and criteria from the + previous version release and update as necessary. + + +**Patch** Updates +^^^^^^^^^^^^^^^^^^ + +Patch updates do not require a full project. Bug fixes required in the patch should be collected +as sub-issues under a Patch parent/tracker issue. + + +After ``test`` is updated +------------------------- +- 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. diff --git a/docs/_src/index.rst b/docs/_src/index.rst index 3bfc9b42fc..3fbc7943de 100644 --- a/docs/_src/index.rst +++ b/docs/_src/index.rst @@ -68,6 +68,7 @@ Team Culture _wiki/RuFaS-Versioning-Policy _wiki/SCRUM-at-RuFaS + _wiki/Version-Update-Workflows Release Notes -------------