Skip to content

Commit ee84452

Browse files
committed
Add PaddlePaddle community governance and code of conduct documentation.
1 parent e5da32e commit ee84452

File tree

2 files changed

+212
-0
lines changed

2 files changed

+212
-0
lines changed

CODE_OF_CONDUCT.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# PaddlePaddle Community Code of Conduct
2+
3+
* The PaddlePaddle Community Code of Conduct refers to the [CNCF Community Code of Conduct] (https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
4+
5+
### Contributor Code of Conduct
6+
7+
As a contributor and maintainer of this project, in order to build an open and popular community, we promise to respect all those who contribute by reporting issues, issuing feature requests, updating documentation, submitting pull requests or patches, and other activities.
8+
9+
We are committed to keeping everyone involved in this project free from harassment, regardless of their experience level, gender, gender identity and expression, sexual orientation, disability, personal appearance, body type, race, race, age, religion or nationality, etc.
10+
11+
Unacceptable participant behavior includes:
12+
13+
- Use of sexual language or images
14+
- Personal attacks
15+
- Provocative, insulting or derogatory comments
16+
- Public or private harassment
17+
- Publishing other people’s private information, such as addresses or email addresses, without explicit permission
18+
- Other unethical or unprofessional behavior
19+
20+
The project maintainer has the right and responsibility to delete, edit or reject comments, submissions, code, wiki edits, questions, and other contributions that do not comply with this Code of Conduct. By adopting this code of conduct, the project maintainer promises to apply these principles to all aspects of project management in a fair and consistent manner. Project maintainers who do not follow or implement the code of conduct may be permanently removed from the project team.
21+
22+
When an individual represents a project or its community, this code of conduct applies to project spaces and public spaces.
23+
24+
To report insults, harassment, or other unacceptable behavior, you can send an email to <paddle-better@baidu.com>.

GOVERNANCE.md

+188
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
# PaddlePaddle Open Governance
2+
3+
## Overall Purpose
4+
5+
While expanding PaddlePaddle's technical landscape and increasing user community contributions, PaddlePaddle also maintains its integrity and improves the quality of contributions.
6+
7+
## Specific Target
8+
9+
- Clarify the relationship between the project, PaddlePaddle project personnel and community contributors.
10+
- Attract more community participation and create an effective TOC contribution and recognition portal.
11+
- While reducing the workload of the TOC on certain projects, retaining the executive control and integrity of the agency.
12+
- Avoid establishing political platforms between vendors.
13+
- Strengthen the project ecosystem to meet the needs of end users and project contributors.
14+
- Identify gaps in the PaddlePaddle project portfolio, find and attract projects to fill these gaps.
15+
- Educate and guide users to provide users with unbiased, effective and practical information.
16+
- Focus attention and resources on promoting the maturity of the PaddlePaddle project.
17+
18+
## Introduction
19+
20+
PaddlePaddle SIG will supervise and coordinate the interests related to the logical areas of end users and/or project requirements. Usually a group of PaddlePaddle projects meets the domain of SIG supervision, or it may be a cross-domain feature group shared by multiple projects (such as security and observability).
21+
22+
SIG is:
23+
24+
- A long-standing group, reporting to the Technical Oversight Committee TOC.
25+
- Mainly led by recognized experts in related fields and supported by other contributors.
26+
27+
TOC is:
28+
29+
- The technical management organization of PaddlePaddle organization. It recognizes and supervises all projects under the PaddlePaddle organization and authorizes the promotion of a neutral consensus.
30+
- Define and maintain the technical vision of PaddlePaddle deep learning ecology.
31+
- Approve new projects within the scope of PaddlePaddle specified by the Board of Directors (GB), and create a conceptual framework for the project, adjust the project, delete or archive the project.
32+
- Accept feedback from the end user committee and map it to the project.
33+
- Align the interface with the components under management (the code reference implementation before standardization), and define common practices (if any) to be implemented in the PaddlePaddle project.
34+
35+
## SIG's responsibilities and rights
36+
37+
Under the guidance of TOC, PaddlePaddle SIG provides high-quality professional technical knowledge, unbiased information and leadership in the field. As an informed party and an efficient executive committee, TOC uses this input to select and promote appropriate PaddlePaddle projects and practices, and disseminate high-quality information to end users and the community.
38+
39+
The SIG should strive to provide the TOC with a “proposition” that is easy to understand and voteable, and the proposal needs to be supported by clear documentary evidence. These proposals can be: "based on written due diligence" or "approval of the landscape document based on clear goals and evidence." The information and advice provided by the SIG to the TOC must be highly accurate and fair, which is very important. This is also driven by the goal of improving PaddlePaddle as a whole, rather than benefiting one project or company from other projects or companies.
40+
41+
The reason for this design is to consider:
42+
43+
- TOC is the arbitrator and writer, and may always intervene and reject proposals.
44+
- SIG is a respected talented group.
45+
46+
SIG can choose to form a time-limited centralized working group to fulfill certain responsibilities (for example, making specific educational white papers or combined blank analysis reports). The working group WG should have a clearly documented charter, timetable (usually a few quarters at most) and a set of deliverables. Once the timetable passes or the results are delivered, the working group will be dissolved and reorganized.
47+
48+
### Specific SIG responsibilities
49+
50+
#### Project handling:
51+
52+
- Understand and record the high-level roadmap of projects in this field, including PaddlePaddle and non-PaddlePaddle projects. Identify gaps in the project prospects.
53+
- For PaddlePaddle projects, perform a health check.
54+
- Discover and exhibit pairs of candidate projects.
55+
- Help candidate projects prepare for submission to TOC.
56+
- Each PaddlePaddle project will be assigned to an appropriate SIG by TOC.
57+
58+
#### End user education
59+
60+
- Provide the latest, high-quality, unbiased and easy-to-use materials to help end users understand and effectively adopt cloud native technologies and practices in the SIG field, such as:
61+
- White papers, presentations, videos or other forms of training, clarification of terminology, comparison of different methods, available projects or products, common or recommended practices, trends, illustrative successes and failures, etc.
62+
- Information should be collected based on research and facts as much as possible, rather than pure marketing or speculation.
63+
64+
#### End user input collection
65+
66+
- Collect useful end user input and feedback on expectations, pain points, main use cases, etc.
67+
- Compile it into easy-to-use reports and/or presentations to help the project with functional design, prioritization, UX, etc.
68+
69+
#### Community Support
70+
71+
- SIG is an open organization that provides meetings, meeting agendas and notes, mailing lists and other public communications.
72+
- The SIG mailing list, SIG meeting calendar and other communication documents will be publicly released and maintained.
73+
74+
#### As a trusted expert advisor for TOC
75+
76+
- Conduct technical due diligence on new projects and graduation projects, and make recommendations to TOC on the results of the investigation.
77+
- Participate in or regularly check projects in their field, and provide TOC with recommendations on health, status and measures (if any) as needed or upon request.
78+
79+
#### SIG Charter:
80+
81+
- Formally reviewed annually and approved by TOC. The charter must clearly state:
82+
- Which are within the scope of the SIG and which are not;
83+
- Communicate with other PaddlePaddle SIG or other related groups to clarify whether there is overlap;
84+
- How to operate and manage, whether and how to deviate from the standard SIG operating guidelines provided by TOC. Deviations from these guidelines are discouraged unless there is a well-documented reason for this disagreement approved by the TOC.
85+
86+
## Operation Model
87+
88+
Important note: Each SIG is supported by a designated member of PaddlePaddle's executive staff, who is responsible for liaison with the head of PaddlePaddle, communication and performance of the SIG, and submit quarterly and annual reports to the Board of Directors BD and TOC.
89+
90+
### SIG formation, leadership and membership
91+
92+
1. SIG is formed by TOC. The initial SIG is listed below and will be adjusted over time as needed. If community members think that additional SIG needs to be added, they should raise it to TOC and give a clear reason. It is best to have volunteers lead the SIG. TOC wants to have the smallest number of feasible SIGs, and all SIGs are efficient.
93+
94+
2. The SIG has three co-chairs who are TOC contributors, recognized experts in the field, and have the ability to co-lead the SIG to generate unbiased information.
95+
96+
3. The SIG has a TOC liaison who serves as a voting member of the TOC and acts as an additional non-executive chairman when the TOC or SIG chairman deems it necessary to submit the TOC.
97+
98+
4. SIG has a number of technical leaders who are recognized as (1) experts in the SIG field, (2) project leaders in the SIG field, and (3) demonstrated the balancing techniques needed to provide unbiased information needed to generate SIG leadership. The main reason for adopting the role of independent chairman and technical director is to separate the responsibilities of administrative functions from the deep technical functions and related time commitments and skill sets. Under appropriate circumstances, individuals can perform both roles at the same time (see below).
99+
100+
5. Strongly encourage diversity of ideas and interests within SIG.
101+
102+
6. SIG members are appointed by themselves, so some SIG work is done by TOC contributors and community volunteers. In order to identify members who have made continuous and valuable contributions to the SIG over time, roles defined and assigned by the SIG can be created (for example, training or document coordinator, etc.). The SIG should record what these roles and responsibilities are, who is the performer, and have the SIG leader approve.
103+
104+
### SIG Life Cycle
105+
106+
#### Research and consultation
107+
108+
Proposers of the SIG should consider the following questions:
109+
110+
* A clearly defined problem or set of problems that the group can solve.
111+
* Consult with the beneficiary community members to assess their interests and willingness to commit.
112+
* For existing projects, contributors’ concerns and corresponding Pull Reuest evidence.
113+
* Potential goals to be achieved by the team.
114+
* The resource requirements of the operation group.
115+
116+
#### Create a new group
117+
118+
The new team should follow the following procedures for licensing, the following are the specific requirements:
119+
120+
* The clear purpose and advantages of the new group (around sub-projects or application areas)
121+
* Two or more contributors who are willing to act as the team leader, the existence of other contributors and evidence of team needs
122+
* Resources required initially (usually mailing lists)
123+
* The approval of this group will be determined by the TOC team.
124+
* Promote the new SIG through discussion groups and PaddlePaddle website
125+
126+
#### Group Operations
127+
128+
Teams should choose to use collaboration to conduct meetings through scheduled conference calls or chat channels. Any such meetings should be advertised on the mailing list, and then comments should be posted on the mailing list. Regular meetings help advance the accountability and SIG progress. Members of the PaddlePaddle community team will actively monitor and encourage the group to conduct appropriate discussions.
129+
130+
131+
### SIG member role
132+
133+
#### Chairman
134+
135+
- Three event seats rotating weekly/bi-weekly/monthly.
136+
- Mainly perform management functions, including collecting and compiling weekly (bi-weekly) agenda topics, presiding over meetings, ensuring the release of high-quality meeting minutes, and tracking and solving follow-up actions.
137+
- If someone has the time and ability to perform these two roles at the same time, as long as the TOC and SIG members are satisfied, they can be performed by the technical director.
138+
139+
#### technical director
140+
141+
- Leading SIG projects.
142+
- Is there time and ability to conduct in-depth technical exploration of the project. Projects may include formal PaddlePaddle projects or other projects in the areas covered by the SIG.
143+
144+
#### Other named roles
145+
146+
- Named and defined by SIG (e.g. public relations supervisor, document/training supervisor, etc.)
147+
- Approved by the vast majority of chairpersons.
148+
149+
#### other members
150+
151+
- Self-appointment
152+
- There may be no clear roles or responsibilities, and no officially assigned roles (see above).
153+
- Except for the designated roles, the public should not be given the impression that they have any authority or formal responsibilities in the SIG.
154+
155+
### Election
156+
157+
- TOC nominates the chairman
158+
- After a 2/3 majority vote of the TOC, the chairperson was assigned
159+
- Two-year term but staggered so that at least one seat can maintain continuity
160+
- TOC and the chairman nominate technical director
161+
- The technical director needs to obtain a 2/3 majority of the TOC and a 2/3 majority of the SIG chairman
162+
- After obtaining a 2/3 majority vote of the TOC, the SIG chairman and technical director can be cancelled at any time
163+
164+
### Governance
165+
166+
- All SIGs inherit and follow PaddlePaddle TOC operating principles.
167+
- The SIG must have a documented governance process that encourages community participation and clear guidelines to avoid biased decisions.
168+
-Note: The goal here is to be consistent with the "minimum feasible" model of the PaddlePaddle project, and only need such governance, not any overly cumbersome things
169+
- If they conform to the operating principles of PaddlePaddle, they may gradually implement a series of practices over time, just like the OSS project.
170+
- Like the PaddlePaddle project, all exceptions and disputes are handled by TOC and PaddlePaddle staff with help
171+
172+
### Budget and resources
173+
174+
- There is no formal system budget at this time, except for PaddlePaddle executives who promise to provide designated personnel as contact points.
175+
- Just as the PaddlePaddle project may need "help" provided by PaddlePaddle, SIG can request corresponding resources through the PaddlePaddle Liaison Office.
176+
177+
## Retire
178+
179+
- In the event that SIG is unable to establish and perform duties and/or regularly report to TOC, TOC will:
180+
- Consider disbanding (retire) SIG after 3 months
181+
- SIG must be dissolved after 6 months
182+
- TOC can pass the "no confidence" of SIG with a 2/3 majority vote. In this case, the TOC can vote to dissolve or reorganize the SIG.
183+
184+
## Initial SIG
185+
186+
To begin the process, TOC proposes the following SIGs and the items assigned to each SIG. Obviously, all of these SIGs will not be fully formed overnight or immediately begin to operate, so the TOC itself will perform the duties of the unformed SIG until the SIG is formed. However, we can immediately designate a voting member of the TOC as the liaison for each SIG, and give priority to the order of formation of the SIG, starting with the most urgent SIG immediately.
187+
188+
TOC and PaddlePaddle staff will work together to draft a set of the above-mentioned preliminary charter and collect/election suitable seats.

0 commit comments

Comments
 (0)