-
Notifications
You must be signed in to change notification settings - Fork 204
Rename "Complete" project stage to "Feature-Complete", add new "Sunsetting" stage #1654
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
base: main
Are you sure you want to change the base?
Changes from 4 commits
543ac4f
79e37c5
38be03b
f298301
9b35161
2c09652
b7daf7e
742ee6f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,18 +27,21 @@ flowchart TD | |
F --> Graduated | ||
subgraph Graduated | ||
direction LR | ||
a([Project Status: Impact]) <--> b([Project Status: At Large]) | ||
b <--> c([Project Status: Complete]) | ||
a([Project Status: Impact]) <--> b([Project Status: At Large]) <--> G([Project Status: Feature-complete]) | ||
end | ||
Graduated --> I([Project Status: Archived]) | ||
Graduated --> J{EOL announced?} | ||
J --> |Yes| H([Project Status: Sunsetting]) | ||
H --> K{EOL reached?} | ||
K --> |Yes| I([Project Status: Archived]) | ||
``` | ||
|
||
#### Project Stages | ||
| Stage | New Feature Development | Vulnerability & Bug fixes | | ||
|-------|---------------------|--------------| | ||
| Active (At Large/Impact) | ✅ | ✅ | | ||
| Complete | ❌ | ✅ | | ||
| Archived | ❌ | ❌ | | ||
| Stage | New Feature Development | Vulnerability & Bug Fixes | EOL Announced | EOL Reached | | ||
|-------|-------------------------|---------------------------|---------------|-------------| | ||
| Active (At Large/Impact) | ✅ | ✅ | ❌ | ❌ | | ||
| Feature-complete | ❌ | ✅ | ❌ | ❌ | | ||
| Sunsetting | ❌ | ✅ | ✅ | ❌ | | ||
| Archived | ❌ | ❌ | ✅ | ✅ | | ||
|
||
### Project Proposal Requirements | ||
|
||
|
@@ -231,7 +234,7 @@ To graduate from At Large stage or for a new project to join as an Impact projec | |
|
||
#### Definition | ||
|
||
Incubating projects are projects that are in the process of completing their on-boarding checklist to join the foundation. Projects in this phase may be looking to join the foundation as At-Large, Impact, or Complete Stage. Members of incubating projects are invited to join Cross Project Council meetings as a guest, please refer to the [CPC Charter](./CPC-CHARTER.md) for details on how guests may participate in the meetings. | ||
Incubating projects are projects that are in the process of completing their on-boarding checklist to join the foundation. Projects in this phase may be looking to join the foundation as At-Large, Impact, or Feature-complete Stage. Members of incubating projects are invited to join Cross Project Council meetings as a guest, please refer to the [CPC Charter](./CPC-CHARTER.md) for details on how guests may participate in the meetings. | ||
tobie marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
#### Examples | ||
|
||
|
@@ -247,27 +250,33 @@ It is expected that incubating project will make an active effort to work throug | |
|
||
<!--If this checklist is updated please ensure `https://github.com/openjs-foundation/project-status/blob/HEAD/.github/ISSUE_TEMPLATE/02-project-sunsetting-checklist-template.md` is updated as well --> | ||
|
||
### Sunsetting Projects | ||
### Feature-complete Projects | ||
|
||
Projects that are being sunset fall into two statuses: Complete and Archived. | ||
#### Definition | ||
|
||
An OpenJS software project is Feature-complete when the developers responsible for it are no longer providing feature development or enhancements and are solely providing security updates and bug fixes. The software doesn't disappear; it remains functional but is not under active development. | ||
|
||
#### Complete | ||
#### Acceptance Criteria | ||
|
||
##### Definition | ||
Projects may be granted Feature-complete status through CPC consensus and with the approval of the maintainers of the project. | ||
|
||
An OpenJS software project is Complete, when the developers responsible for it are no longer providing feature development or enhancements and are solely providing security updates and bug fixes. The software doesn't disappear; it remains functional but is not under active development. | ||
In cases where the project maintainers aren't responding after having been repeatedly contacted through appropriate channels about the CPC's intent to move the project to Feature-complete stage, the CPC may proceed with the stage change to either Feature-complete, Sunsetting, or Archived without approval from the maintainers. | ||
|
||
|
||
If a Complete project plans to cease security updates and bug fixes it should have a publicly communicated milestone/date, indicating when all activity on the project will cease. Once this date is reached, the project should follow the steps outlined in the Archived project checklist. | ||
### Sunsetting Projects | ||
|
||
##### Acceptance Criteria | ||
#### Definition | ||
|
||
Projects may be granted Complete status through CPC consensus and with the approval of the maintainers of the project. | ||
An OpenJS software project is Sunsetting when the developers responsible for it have announced a publicly communicated milestone/date indicating when all maintenance activity will cease. During this period, the project continues to provide security updates and bug fixes until the announced end-of-life date. | ||
|
||
In cases where the project maintainers aren't responding after having been repeatedly contacted through appropriate channels about the CPC's intent to move the project to Complete stage, the CPC may proceed with the stage change to either Complete or Archived without approval from the maintainers. | ||
#### Acceptance Criteria | ||
|
||
Projects move to Sunsetting status when maintainers of a Feature-complete project announce an end-of-life date. Once this date is reached, the project should follow the steps outlined in the Archived project checklist. | ||
tobie marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
In cases where the project maintainers aren't responding after having been repeatedly contacted through appropriate channels about the CPC's intent to move the project to Sunsetting stage, the CPC may proceed with the stage change to either Sunsetting or Archived without approval from the maintainers. | ||
|
||
#### Archived | ||
### Archived Projects | ||
|
||
#### Definition | ||
|
||
When an OpenJS project is Archived, it is typically moved to a storage state where the code and resources remain accessible but are no longer actively developed or maintained. Archiving is often done to projects that are obsolete, have been superseded by newer projects, or are no longer viable to maintain. | ||
|
||
|
@@ -289,15 +298,15 @@ A project's progress toward its growth plan goals will be reviewed on a regular | |
|
||
Projects are generally expected to meet their growth plan goals within two years. | ||
|
||
## V. Complete Project Checklist | ||
## V. Feature-complete Project Checklist | ||
|
||
Projects that are transitioning to Complete should follow this checklist. Tasks will be completed together with the CPC and Foundation staff. The goal is to make sure that the Foundation is able to make required changes to the project if the need arises, and revive the project should this become desirable. If you have any questions or need help, the OpenJS Foundation CPC is available to assist. | ||
Projects that are transitioning to Feature-complete stage should follow this checklist. Tasks will be completed together with the CPC and Foundation staff. The goal is to make sure that the Foundation is able to make required changes to the project if the need arises, and revive the project should this become desirable. If you have any questions or need help, the OpenJS Foundation CPC is available to assist. | ||
|
||
### Prepare Project For Complete | ||
### Prepare Project for Feature-complete Stage | ||
|
||
- [ ] Decide in collaboration with the CPC if the project should go through the Complete phase or be directly moved to Archived | ||
- [ ] Update the README with a prominent notice declaring the project to be "Complete" and what kind of updates the project will continue to receive | ||
- [ ] If all updates to the project are planned to eventually stop, provide a date when this would occur | ||
- [ ] Decide in collaboration with the CPC if the project should move to Feature-complete stage, or transition directly to Sunsetting or Archived | ||
- [ ] Update the README with a prominent notice declaring the project to be "Feature-complete" and what kind of updates the project will continue to receive | ||
- [ ] If announcing an end-of-life date for maintenance, the project will move to Sunsetting stage instead | ||
- [ ] Provide a clear explanation for the decision to cease active developement on the project. | ||
- [ ] Consider creating a separate notice, issue, or blog post for wider visibility. | ||
|
||
|
@@ -316,26 +325,38 @@ Projects that are transitioning to Complete should follow this checklist. Tasks | |
- [ ] Create a list of collaborators/contributors in the repository for historical reference. | ||
- [ ] Address any outstanding issues or pull requests with a closing message explaining the status. | ||
- [ ] Update project website, charter, and README to reflect the Stage | ||
- [ ] Mark project in the CPC repo's README.md as "Complete" | ||
- [ ] Mark project in the CPC repo's README.md as "Feature-complete" | ||
- [ ] Update security policy (see [PROJECT_SECURITY_REPORTING](https://github.com/openjs-foundation/cross-project-council/blob/main/PROJECT_SECURITY_REPORTING.md)) (if applicable) | ||
|
||
|
||
## VI. Archived Project Checklist | ||
## VI. Sunsetting Project Checklist | ||
|
||
Projects that are transitioning to Archived should follow this checklist. Tasks will be completed together with the CPC and Foundation staff. The goal is to make sure that the Foundation is able to make required changes to the project if the need arises, and revive the project should this become desirable. If you have any questions or need help, the OpenJS Foundation CPC is available to assist. | ||
Projects that have announced an end-of-life date for maintenance activities and are therefore transitioning to Sunsetting stage should follow this checklist. Tasks will be completed together with the CPC and Foundation staff. The goal is to provide clear communication about the end-of-life timeline while continuing maintenance until the announced date. If you have any questions or need help, the OpenJS Foundation CPC is available to assist. | ||
|
||
### Prepare Project For Archiving | ||
### Prepare Project For Sunsetting | ||
|
||
- [ ] Decide in collaboration with the CPC whether the project needs to be Archived or whether a call for maintenance is warranted. | ||
- [ ] Ensure all critical issues and pull requests are resolved or properly documented. | ||
- [ ] Before archiving, thoroughly review the repository for any sensitive data such as credentials, API keys, or personal information that should not be publicly archived. | ||
- [ ] Release a final version of the project, if applicable, marking or tagging it clearly as the last official release. | ||
- [ ] Decide in collaboration with the CPC on the end-of-life date for when maintenance will cease | ||
|
||
### Community Communication | ||
|
||
- [ ] Announce the intention to archive the project well in advance through all available channels, such as the project's mailing list, social media, and GitHub itself. | ||
- [ ] Provide a clear explanation for why the project is being archived and, if possible, recommend alternatives or forks. | ||
- [ ] Open a discussion for community feedback and potential maintainers interested in forking or taking over the project | ||
- [ ] Announce the end-of-life date and intention to eventually archive the project through all available channels, such as the project's mailing list, social media, and GitHub itself | ||
- [ ] Provide a clear explanation for why the project is sunsetting and, if possible, recommend alternatives or forks | ||
- [ ] Open a discussion for community feedback and potential maintainers interested in forking or taking over the project before the end-of-life date | ||
|
||
### Project Updates | ||
|
||
- [ ] Update project website, charter, and README to reflect Sunsetting stage | ||
- [ ] Mark project in the CPC repo's README.md as "Sunsetting" | ||
|
||
## VII. Archived Project Checklist | ||
|
||
Projects that are transitioning to Archived should follow this checklist. Tasks will be completed together with the CPC and Foundation staff. The goal is to make sure that the Foundation is able to make required changes to the project if the need arises, and revive the project should this become desirable. If you have any questions or need help, the OpenJS Foundation CPC is available to assist. | ||
|
||
### Prepare Project For Archiving | ||
|
||
- [ ] Ensure all critical issues and pull requests are resolved or properly documented | ||
- [ ] Before archiving, thoroughly review the repository for any sensitive data such as credentials, API keys, or personal information that should not be publicly archived | ||
- [ ] Release a final version of the project, if applicable, marking or tagging it clearly as the last official release | ||
|
||
### Archive Related Materials | ||
|
||
|
@@ -380,7 +401,7 @@ As part of the yearly rhythm of Foundation and Project communications, the CPC w | |
* Verify or update their maintainers' contact information (GitHub handle and email). | ||
* Raise concerns with the CPC | ||
* Provide other relevant information | ||
* Responses from the Project Health Survey will be delivered to the Foundation and CPC for consideration, including discussions of Archiving and Complete activities, and proactive support for projects in need. | ||
* Responses from the Project Health Survey will be delivered to the Foundation and CPC for consideration, including discussions of transitioning projects to Feature-complete, Sunsetting or Archived stage, and proactive support for projects in need. | ||
|
||
|
||
|
||
|
Uh oh!
There was an error while loading. Please reload this page.