notaryproject / .github

Organization-wide repository for common governance documents.
https://notaryproject.dev/
Apache License 2.0
3 stars 5 forks source link

doc: Clarify the Repository lifecycle #37

Closed FeynmanZhou closed 11 months ago

FeynmanZhou commented 1 year ago

fix #36

SteveLasker commented 1 year ago

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.

FeynmanZhou commented 1 year ago

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.

FeynmanZhou commented 1 year ago

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.

FeynmanZhou commented 1 year ago

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