Conversation
|
Current Coverage: 99% Mypy errors on update_scidoc_guide branch: 1190 |
|
🚨 Please update the changelog. This PR cannot be merged until |
|
Current Coverage: 99% Mypy errors on update_scidoc_guide branch: 1195 |
|
🚨 Please update the changelog. This PR cannot be merged until |
morrowcj
left a comment
morrowcj
left a comment
There was a problem hiding this comment.
I made a few comments and minor language suggestions in the google doc.
Regarding your slack message:
- I think the guidelines make sense
- I think there is an appropriate level of detail
- I don't have suggestions about workflow
- No questions or concerns.
|
Thank you so much for reviewing! I looked through your suggested edits and comments and they all make sense to me! I'll incorporate what I can today and find answers to the comments that I cannot resolve alone. |
2 participants
Context
Issue(s) closed by this pull request: closes #2807
Updates and additions to the RuFaS model require concurrent updates to documentation and methodology. Updating and maintaining scientific documentation is largely conducted by RuFaS SME team, with support from SWE. These guidelines were created to inform maintainers how to ensure documentation stays current and connect them with resources (templates etc.) to streamline this process.
Draft Guide
What
This PR is to create the guide in the current Wiki.
Why
Proper and up to date documentation is integral to maintaining transparency with the open-source RuFaS model.
How
Creating this file for reference will ensure updates are straightforward and consistent.
Test plan
NA
Input Changes
NA
Output Changes
Filter