cd
cd copied to clipboard
Outline the review-change process
Notes from review meeting: 2022-07-28
We need to nail down how we're going to use github to implement review suggestions, communicate these changes to the review team and leave an audit trail of changes made during this stage of the review. Process for the repo docs (termlist, etc) will differ to the wiki, but simpler is gooder.
Already decided/discussed:
- after each review, log issues for changes required, tag with the 'review' label and add to the 'Review tasks' project
- create 'review' branch for repo files and push any changes there
- for changes to the termlist, update the csv rather than each individual issue, because it's quicker.
- for changes to the wiki, make sure to use the 'edit message' to describe roughly what has changed/why and use the footer.
- when a change has been made, close the issue and reference the github commit or wiki version showing the end change.
I've made a review branch: https://github.com/tdwg/cd/tree/review 🌳
Updated Jutta's changes page to be a Release Notes page.
Before you start the review.
- Create a pdf of the wiki and upload it to the files section of the master branch.
Naming convention: LtC_wiki_v[number]. Add the link to this file into the footer. Note that all branches share the wiki section of the repo, so you should do this first!
- Create a new “review” branch. Work here until the review phase is complete.
- Reviewer suggestions/recommendations (issues)
Create new issues as needed Document any discussion about suggestion/recommendation in the issue. These should be moved to done in the project and then closed when the LtC team and the review panel agree that they have been adequately addressed.
- Term updates (issues)
Document any discussion about proposed changes to a particular term in its issue. Once a final decision is made update the term definition in the issue AND also in the csv in the review repo NOT in the googlesheet version. These should only be closed if the class or property is deprecated.
- Wiki updates
Even though the wiki is shared between the master repo and any clone you should note, major additions and changes in the Release Notes page.
When the review phase is complete
- Merge the review branch back in the master
@rondlg et al - turns out that it's also to create a local clone of the wiki (https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages#cloning-wikis-to-your-computer), so I've done that and copied the md files for v1 into a wiki_archive folder in the main repo (master branch): https://github.com/tdwg/cd/tree/master/standard/wiki_archive. I also moved the pdf version to there from the repo root folder.