-
Notifications
You must be signed in to change notification settings - Fork 61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Process README.md #219
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this change! A few minor comments.
process/README.md
Outdated
|
||
Working Groups and Projects have a different lifecycle as defined below: | ||
Technical Initiatives (TIs) include Working Groups (WGs), Special Interest Groups (SIGs) and Projects (both code and specificiations). All TIs follow a common lifecyle, with 4 stages: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we could merge these descriptions / abbreviations with "I. Overview" and just use the abbreviations here?
process/README.md
Outdated
@@ -22,8 +22,16 @@ flowchart TD | |||
The process is designed to be flexible to enable a Project to move in and out of a Working Group as deemed appropriate by the TAC. | |||
|
|||
# II. Lifecycle | |||
<img align="top" src="https://github.com/ossf/tac/blob/main/process/TI-lifecycle-stages.png"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Breaking up walls of text with images is nice, but do we want some sort of lead-in here like "Here are the four stages of the TI lifecycle:"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually don't think that this image really adds anything as it stands, it should at least have some arrows showing the progression from one stage to the other. Otherwise it's just duplicative of the bulleted list.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll add some arrows to illustrate workflow, thanks for the suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually replaced the image with a mermaid graph that has the arrows.
Signed-off-by: CRob <[email protected]>
typo & spacing correction Signed-off-by: CRob <[email protected]>
bddc248
to
2ce240c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few typos but LGTM otherwise.
Signed-off-by: Arnaud J Le Hors <[email protected]>
Signed-off-by: Arnaud J Le Hors <[email protected]>
Signed-off-by: Arnaud J Le Hors <[email protected]>
Signed-off-by: Arnaud J Le Hors <[email protected]>
I hope you won't mind @SecurityCRob that I basically hijacked your PR and that you will like the changes. |
Signed-off-by: Arnaud J Le Hors <[email protected]>
801b24e
to
9f2faba
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the changes look good to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Reflecting updates aligning TI lifecycle