IEEE.org     |     IEEE Xplore Digital Library     |     IEEE Standards     |     IEEE Spectrum     |     More Sites

maintain.md 6.5 KB
Newer Older
Joshua Gay's avatar
Joshua Gay committed
1
# IEEE OPEN SOURCE MAINTAINERS MANUAL
Joshua Gay's avatar
Joshua Gay committed
2
3


Joshua Gay's avatar
Joshua Gay committed
4
## Conduct
Joshua Gay's avatar
Joshua Gay committed
5

Joshua Gay's avatar
Joshua Gay committed
6
7
8
9
All articipants of IEEE Open Source Projects are expected to demonstrate respect 
and courtesy toward each other. All maintainers shall act in accordance with the 
[IEEE Code of Conduct](https://www.ieee.org/about/ieee_code_of_conduct.pdf) and 
encourage all other partcipants in the projects they maintain to do the same. 
Joshua Gay's avatar
Joshua Gay committed
10

Joshua Gay's avatar
Joshua Gay committed
11
12
13
14
In addition, with regard to the following referenced section of the 
IEEE Policies document, any given requirements or recommendation that applies 
to an IEEE Member shall be understood to apply equally to an 
IEEE Open Source Project Maintainer. 
Joshua Gay's avatar
Joshua Gay committed
15

Joshua Gay's avatar
Joshua Gay committed
16
17
18
19
* Definitions of Bullying, Discrimination, Harassment, and Retaliation. 
* IEEE Code of Ethics (§7.8)
* Civility Policy, nondiscrimintation (§9.25)
* IEEE Policy Against Discrimination and Harassment (9.26)
Joshua Gay's avatar
Joshua Gay committed
20
21


Joshua Gay's avatar
Joshua Gay committed
22
## Organization of Projects and Materials 
Joshua Gay's avatar
Joshua Gay committed
23

Joshua Gay's avatar
Joshua Gay committed
24
25
26
27
28
29
30
The IEEE Open Source Platform consists of the code and document
repositories, license repositories, communication forums, project
management systems, and related administrative and end-user tools
maintained by IEEE for the purpose of hosting Open Source projects
together with the associated governance mechanisms, support
mechanisms, and other services offered to participants, users, and
consumers of Open Source projects.
Joshua Gay's avatar
Joshua Gay committed
31

Joshua Gay's avatar
Joshua Gay committed
32
33
An open source project may oranize material and conduct business
across various parts of the IEEE Open Source Platform.
Joshua Gay's avatar
Joshua Gay committed
34

Joshua Gay's avatar
Joshua Gay committed
35
36
37
An IEEE Open Source Project must provide a single URL that can be
considered as the official homepage of the project. For example, this
could be the link to a project page on opensource.ieee.org.
Joshua Gay's avatar
Joshua Gay committed
38

Joshua Gay's avatar
Joshua Gay committed
39
### Homepage
Joshua Gay's avatar
Joshua Gay committed
40

Joshua Gay's avatar
Joshua Gay committed
41
On the IEEE Open Source Project Homepage, the following information must be provided (e.g., in a repo's READEME.md file) the following information:
Joshua Gay's avatar
Joshua Gay committed
42

Joshua Gay's avatar
Joshua Gay committed
43
44
45
46
47
48
* Project name
* Any important status concerns prominantly displayed (e.g., a notice that it is unmaintained or archived, etc)
* A short description of how the project is organized
* Project license and links to appropriate CLAs
* How to contribute (such as a link to a CONTRIBUTING file)
* Project leadership
Joshua Gay's avatar
Joshua Gay committed
49

Joshua Gay's avatar
Joshua Gay committed
50
### Repository
Joshua Gay's avatar
Joshua Gay committed
51

Joshua Gay's avatar
Joshua Gay committed
52
Each open source project area that makes use of a git repository shall have the following files in any   
Joshua Gay's avatar
Joshua Gay committed
53

Joshua Gay's avatar
Joshua Gay committed
54
55
56
57
58
59
* README  - Project name, short description, license and CLA info, 
* LICENSE - The official license of the project
* NOTICES - Any additional appropriate legal notices that must be included
* AUTHORS - A list of copyright holders
* CONTRIBUTORS - A list of contributors 
* CONTRIBUTING (Governance and Code-of-Conduct)  - Rules for contributing, may be split into a separete GOVERNANCE document
Joshua Gay's avatar
Joshua Gay committed
60

Joshua Gay's avatar
Joshua Gay committed
61
### Appropriate legal notices
Joshua Gay's avatar
Joshua Gay committed
62

Joshua Gay's avatar
Joshua Gay committed
63
Following best practices, files should contain a copyright and license notice. 
Joshua Gay's avatar
Joshua Gay committed
64

Joshua Gay's avatar
Joshua Gay committed
65
## Responsibilities of Maintainers and Committers
Joshua Gay's avatar
Joshua Gay committed
66

Joshua Gay's avatar
Joshua Gay committed
67
68
A maintainer of an IEEE Open Source Project shall have the following
responsibilities:
Joshua Gay's avatar
Joshua Gay committed
69

Joshua Gay's avatar
Joshua Gay committed
70
71
72
* Ensuring, according to this manual, that all appropriate files,
  documentation, and notices are in place for their Project on the
  IEEE Open Source Platform.
Joshua Gay's avatar
Joshua Gay committed
73

Joshua Gay's avatar
Joshua Gay committed
74
* Adhering to the governance rules established by the project IEEE Open Source Project
Joshua Gay's avatar
Joshua Gay committed
75

Joshua Gay's avatar
Joshua Gay committed
76
77
78
79
80
* Responding to communication and notificatoins on the IEEE Open
  Source Platform in a timely manner, as well as communication and
  requests from the IEEE Open Source Lead, and the Open Source
  Community Manager either through the platform or via another
  commuincations channel.
Joshua Gay's avatar
Joshua Gay committed
81
82
83
84
85
86
87
88
89
90

## Stepping Down

If you’re the maintainer of an IEEE Open Source Project and you have decided
to step-down, please inform the IEEE Staff by either sending an email to 
contrib@ieee.org stating the name of the project and the date you are planning 
to step down, and any suggestion or infomration you may have as to who should 
become the new maintainer.  The appointment of a new maintainer needs the 
approval of Leader(s) of the project.

Joshua Gay's avatar
Joshua Gay committed
91
## Security and Critical vulnerabilities
Joshua Gay's avatar
Joshua Gay committed
92

Joshua Gay's avatar
Joshua Gay committed
93
94
95
96
97
* The handling of disclosure of a vulnerability should be done following a responsible process
* All projects should provide a way of having security vulnerabilities disclosures to be done privately, either thorugh an official private mailing list of the project or via private issues/bug reports. 
* The Open Source Community Manager may require specific security and critical vulnerability and exposure procedures to be followed
* In general, the time period for acknowledgin the validity of a critical vulnerability or exposure or similar notification: 15 days
* Total time period required to resolve the issue: 90 days
Joshua Gay's avatar
Joshua Gay committed
98

Joshua Gay's avatar
Joshua Gay committed
99
## Communication
Joshua Gay's avatar
Joshua Gay committed
100

Joshua Gay's avatar
Joshua Gay committed
101
## Naming, Branding, Trademark, and Tradename 
Joshua Gay's avatar
Joshua Gay committed
102

Joshua Gay's avatar
Joshua Gay committed
103
IEEE Policy on Trademark applies to IEEE Open Source Projects. 
Joshua Gay's avatar
Joshua Gay committed
104

Joshua Gay's avatar
Joshua Gay committed
105
## Archiving 
Joshua Gay's avatar
Joshua Gay committed
106

Joshua Gay's avatar
Joshua Gay committed
107
* How and when to move a project to an archived project
Joshua Gay's avatar
Joshua Gay committed
108

Joshua Gay's avatar
Joshua Gay committed
109
## Version
Joshua Gay's avatar
Joshua Gay committed
110

Joshua Gay's avatar
Joshua Gay committed
111
Informatoin for IEEE Open Source Project maintainers. DRAFT
Joshua Gay's avatar
Joshua Gay committed
112

Joshua Gay's avatar
Joshua Gay committed
113
Copyright 2019, The Maintainers Manual AUTHORS (see AUTHORS file)
Joshua Gay's avatar
Joshua Gay committed
114

Joshua Gay's avatar
Joshua Gay committed
115
116
117
The IEEE Open Source Maintainers Manual is licensed to you under the
terms of the Apache License, Version 2.0. You may obtain a copy of the
License at
Joshua Gay's avatar
Joshua Gay committed
118

Joshua Gay's avatar
Joshua Gay committed
119
  http://www.apache.org/licenses/LICENSE-2.0
Joshua Gay's avatar
Joshua Gay committed
120

Joshua Gay's avatar
Joshua Gay committed
121
122
123
124
125
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.  See the License for the specific language governing
permissions and limitations under the License.
Joshua Gay's avatar
Joshua Gay committed
126
127


Joshua Gay's avatar
Joshua Gay committed
128
## About This Document
Joshua Gay's avatar
Joshua Gay committed
129

Joshua Gay's avatar
Joshua Gay committed
130
131
132
***In accordance with the Open Source Committee Operations Manual, all
IEEE Open Source Project Maintainers shall follow the requirements set
forth.***
Joshua Gay's avatar
Joshua Gay committed
133

Joshua Gay's avatar
Joshua Gay committed
134
135
136
This manual contains guidelines, advice, and requirements of interest
to anyone contributing to or participating in an IEEE Open Source
Project.
Joshua Gay's avatar
Joshua Gay committed
137

Joshua Gay's avatar
Joshua Gay committed
138
139
140
We welcome your help in improving this manual. You can file an issue
or become a contributor (see CONTRIBUTE) to this open source project,
which is located at <https://opensource.ieee.org/oscom/maintain>.
Joshua Gay's avatar
Joshua Gay committed
141

Joshua Gay's avatar
Joshua Gay committed
142
143
144
145
All maintainers of IEEE Open Source Projects will be notified when new 
official releases of this manual are released. A version history of all changes 
between official releases of this document within the repository on the open 
source project. 
Joshua Gay's avatar
Joshua Gay committed
146

Joshua Gay's avatar
Joshua Gay committed
147
### Acknowledgements
Joshua Gay's avatar
Joshua Gay committed
148

Joshua Gay's avatar
Joshua Gay committed
149
150
151
152
Thanks go to the Free Software Foundation and the GNU Project for the 
[**GNU Maintainers Manual**](https://www.gnu.org/prep/maintain/maintain.html); 
and  to Karl Fogel for (**Producing Open Source Software**, 2nd edition)[https://producingoss.com/]. 
These works provided useful ideas that we have used in developing this manual. 
Joshua Gay's avatar
Joshua Gay committed
153

Joshua Gay's avatar
Joshua Gay committed
154
155
## Getting Help
{: .gitlab-red}
Joshua Gay's avatar
Joshua Gay committed
156

Joshua Gay's avatar
Joshua Gay committed
157
158
- Contact IEEE Open Source Community Manager
- Alternative contact (e.g., what they need to make a complaint about the OSCM). 
Joshua Gay's avatar
Joshua Gay committed
159