Skip to content

doc: Clarify the Repository lifecycle#37

Merged
FeynmanZhou merged 9 commits intonotaryproject:mainfrom
FeynmanZhou:main
Dec 8, 2023
Merged

doc: Clarify the Repository lifecycle#37
FeynmanZhou merged 9 commits intonotaryproject:mainfrom
FeynmanZhou:main

Conversation

@FeynmanZhou
Copy link
Copy Markdown
Member

fix #36

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Copy link
Copy Markdown
Contributor

@TheFoxAtWork TheFoxAtWork left a comment

Choose a reason for hiding this comment

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

Looks good, please make sure your governance outlines a supermajority and is linked here.

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@SteveLasker
Copy link
Copy Markdown
Contributor

Having the process outlined is goodness. Archiving a repo that's been dormant may not mean the project isn't useful for others to consume as reference. It may just be stable and doesn't need additional changes. In this case, archiving can indicate it's stable, and not taking additional changes, because there aren't any maintainers, or the project is simply stable.

I'd also suggest adding text that a repo must have at least 30 days notice to its maintainers before archival is completed.

Deleting a project is far more destructive and removes content that others may need. I'd suggest we clarify under what circumstances a project would be deleted, vs. archived.

Copy link
Copy Markdown
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Overall looks good. Just one comment.

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou
Copy link
Copy Markdown
Member Author

Having the process outlined is goodness. Archiving a repo that's been dormant may not mean the project isn't useful for others to consume as reference. It may just be stable and doesn't need additional changes. In this case, archiving can indicate it's stable, and not taking additional changes, because there aren't any maintainers, or the project is simply stable.

I'd also suggest adding text that a repo must have at least 30 days notice to its maintainers before archival is completed.

Deleting a project is far more destructive and removes content that others may need. I'd suggest we clarify under what circumstances a project would be deleted, vs. archived.

Thanks @SteveLasker for the suggestions. I added a paragraph about the archival notice and removed the "Removal" section according to your inputs above.

priteshbandi
priteshbandi previously approved these changes Sep 4, 2023
Copy link
Copy Markdown

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Thanks @FeynmanZhou

Copy link
Copy Markdown

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

What about deleting, renaming, and transferring out a repository?

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou
Copy link
Copy Markdown
Member Author

What about deleting, renaming, and transferring out a repository?

@shizhMSFT I added a section for Renaming. Deleting and transferring out a repository are not common cases so we could consider adding them in the future. Keep the content as minimum viable would be easier to review.

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Copy link
Copy Markdown

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Thanks @FeynmanZhou LGTM

@FeynmanZhou
Copy link
Copy Markdown
Member Author

/cc @notaryproject/notaryproject-governance-maintainers to help review this PR.

Copy link
Copy Markdown

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

@FeynmanZhou FeynmanZhou merged commit 7b990c5 into notaryproject:main Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Process for archiving repositories

7 participants