Skip to content
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

Merged
merged 7 commits into from
Nov 24, 2023
Merged

Update Process README.md #219

merged 7 commits into from
Nov 24, 2023

Conversation

SecurityCRob
Copy link
Contributor

Reflecting updates aligning TI lifecycle

Copy link
Member

@steiza steiza left a 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.


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:
Copy link
Member

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?

@@ -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">
Copy link
Member

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:"?

Copy link
Contributor

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.

Copy link
Contributor Author

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

Copy link
Contributor

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.

process/README.md Show resolved Hide resolved
typo & spacing correction

Signed-off-by: CRob <[email protected]>
@lehors lehors force-pushed the SecurityCRob-patch-1 branch from bddc248 to 2ce240c Compare November 21, 2023 07:27
Copy link
Contributor

@lehors lehors left a 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.

process/README.md Outdated Show resolved Hide resolved
process/README.md Outdated Show resolved Hide resolved
process/README.md Outdated Show resolved Hide resolved
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]>
@lehors
Copy link
Contributor

lehors commented Nov 22, 2023

I hope you won't mind @SecurityCRob that I basically hijacked your PR and that you will like the changes.
@steiza I believe this addresses your comments.

Signed-off-by: Arnaud J Le Hors <[email protected]>
@lehors lehors force-pushed the SecurityCRob-patch-1 branch from 801b24e to 9f2faba Compare November 22, 2023 10:02
@lehors lehors changed the title Update README.md Update Process README.md Nov 22, 2023
Copy link
Contributor Author

@SecurityCRob SecurityCRob left a 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

@steiza steiza requested a review from a team November 22, 2023 14:28
Copy link
Contributor

@mlieberman85 mlieberman85 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@SecurityCRob SecurityCRob merged commit b1d534e into main Nov 24, 2023
7 checks passed
@SecurityCRob SecurityCRob deleted the SecurityCRob-patch-1 branch November 24, 2023 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants