cfn/cfn-overview
Code Issues Proposed changes

add guideline folder with guidelines for new subgroup initiation

Browse Source 
Change-Id: I54dd72dbf35875f39e69f2512aa4f083ea27b5c4
This commit is contained in:
qihuiz93 2024-03-27 17:14:31 +08:00
parent 7f8bc9a0d7
commit bd56451d64
1 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
guidelines/Initiate-a-new-sub-group.md Normal file
View File

@ -0,0 +1,53 @@
# **How to initiate a new sub group**
<u>**Please follow this guide to initiate a new sub group under CFN WG.**</u>
## Subgroup Lifecycle & Roles
*Review the subgroup lifecycle & roles to get a clear picture of how subgroups work within CFN WG*
**Subgroup roles**
- **Project Leader:** A subgroup is required to elect a Project Leader. The project leader acts as the de facto spokesperson for the project. The subgroup project leader will be derived from the Comitters of the subgroup.
- **Project primary contact:** Usually similar to Project Leader. Or the most active Committer who can synchronize info with Project Leader.
- **Committer:** Active participants of a subgroup who have been approved for the right to commit code to the source code management system.
- **Contributor:** Participants who contribute to a subgroup. Contributor could play as code reviewer or other artifacts. A Contributor can be promoted to a Committer by the subgroup’s Committers after demonstrating a history of meritocratic contribution to that subgroup.
Project Leader, Peroject primary contact and Comitter are necessary roles for each subgroup. Contributors are recommended. Committers and contributors are support to be added, removed from the subgroup.
**Subgroup lifecycle**
For subgroups, it means internal subgroups under CFN WG. It follows the following lifecycle procedure.
| Subgroup state | State summary |
| --- | --- |
| none | Subgroup does not exist or exists outside of CFN WG.|
| Approved | Subgroup is reviewed and admitted to CFN WG. A team who wants to establish a new subgroup under CFN WG should write a "New Subgroup Proposal" and follow "Create Review Process".|
| Archived | Subgroup is no longer active and stop running.|
## New Subgroup Proposal
Create a new subgroup proposal from the template: <u>https://opendev.org/cfn/cfn-overview/src/branch/master/templates/Template__new_subgroup_proposal.md</u>
If not using the template, please provide any type of material that contains all required contents in the template.
- Fill in the template to describe your proposal.
- Pure document delivery subgroup or code delivery subgroup are both acceptable. If you plan to initiate a subgroup delivering code, Please indicate if you are planning to contribute existing code, or start a new subgroup from scratch.
## Guidelines for Creation Review
The last step before your subgroup is formally created is to have a creation review during a TSC meeting.
- Please e-mail CFN mailing list to schedule the Creation Review. You can ask for your creation review to be scheduled for any TSC meeting that is more than two weeks after the proposal was e-mailed to the mail list or WG contact.
- Proposal introduction by potential subgroup's Project Leader.
- Creation Review typically last 20-30 minutes. People usually either bring slides or just use their proposal if it goes into sufficient detail. A few diagrams of the major components and how they interact are often useful.
## Guidelines for after Creation Review
Once your subgroup receives no objection and has been formally approved by the TSC, you'll want to start getting it set up.
- Ask WG contact to create a new repository for your subgroup.
- Prepare a Sub-group Introduction with the tamplate at <u>https://opendev.org/cfn/cfn-overview/src/branch/master/templates/Template__sub-group%20introduction.md</u> and upload to your repository.
- Upload initial codes and other materials to your repository.
- Start your subgroup work.