
There are three rules, please make an effort to follow them:
1 - FOLLOW THE PROCESS HERE.
2 - REMEMBER TO UPDATE EVERY TIME THE STATUS OF A DOCUMENT CHANGES.
3 - IF YOU HAVE DOUBTS ON HOW THESE COLORS WORK, ASK.
Color code
We have three different things that use color coding.
- Document. The status of the Specification document. This is the big circle next to the name of the specification.
- 🔺 WIP - do not review
- 🟨 Ongoing reviews
- 🟢 Finalized
- Reviewers. These are the ones that should review it in depth. Color code for reviewers:
- 🔺 Not started
- 🟨 Ongoing
- 🟢 Approved
Process
- Remember that documents need to have all comments resolved before we can move them to green.
- Always add Álvaro to review the document. He will move it to green if the document meets the quality requirements for public spec.
- When reviewing, fix typos and obvious grammar mistakes. There is no need to add a comment for this because it pollutes the page and makes following comments there harder. However, if the amount of typos and grammar issues is too high, make sure to raise the issue to the author and stop the review, as your job is not to fix grammar issues - the author should rather use some grammar tool before requesting reviews. We live in the age of AI.
- In case what is above is not clear, this outlines what to do in the different situations:
- Regular Process
- 🔺 New document creation. Starts with 🔺
- Document ready for review
- 🟨 Switch document to yellow.
- 🔺 Add reviewers in red.
- Reviewers: Start reviewing
- 🟨 Everyone who starts reviewing switches to yellow.
- 🟢 When done, reviewer switches to green.
- Fully reviewed document.
- 🟢 When all reviewers are green, the last one switches the document to green.
- Regression. Any time there is a regression:
- If a reviewer retracts the approval, switches to yellow (GOTO step 3).
- If a document an approved document is “reopened” (ie new modifications that require a review process), start over (GOTO step 1)