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

Commit 23f14896 authored by Joshua Gay's avatar Joshua Gay 🙀
Browse files

Update maintain.md

parent 569e9fc9
# IEEE OPEN SOURCE MAINTAINERS MANUAL
## Version
Informatoin for IEEE Open Source Project maintainers. DRAFT
Copyright 2019, The Maintainers Manual AUTHORS (see AUTHORS file)
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
http://www.apache.org/licenses/LICENSE-2.0
## Conduct
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.
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.
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.
## About This Document
* 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)
***In accordance with the Open Source Committee Operations Manual, all
IEEE Open Source Project Maintainers shall follow the requirements set forth.***
This manual contains guidelines, advice, and requirements of interest to anyone
contributing to or participating in an IEEE Open Source Project.
## Organization of Projects and Materials
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>.
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.
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.
An open source project may oranize material and conduct business
across various parts of the IEEE Open Source Platform.
### Acknowledgements
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.
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.
### Homepage
## Getting Help
{: .gitlab-red}
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:
- Contact IEEE Open Source Community Manager
- Alternative contact (e.g., what they need to make a complaint about the OSCM).
* 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
## Responsibilities of Maintainer
### Repository
A maintainer of an IEEE Open Source Project shall have the following
responsibilities:
Each open source project area that makes use of a git repository shall have the following files in any
* Ensuring, according to this manual, that all appropriate files, documentation,
and notices are in place for their Project on the IEEE Open Source Platform.
* Responding to communication and notificatoins on the IEEE OPen Source Platform in a timely manner.
* 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
### Appropriate legal notices
Following best practices, files should contain a copyright and license notice.
## Responsibilities of Maintainers and Committers
### Terminology
A maintainer of an IEEE Open Source Project shall have the following
responsibilities:
When communicating about policies, procedures, or other rules, the following
definitions should be followed: **shall** means "is required to", **should**
means "is recommended that".
* Ensuring, according to this manual, that all appropriate files,
documentation, and notices are in place for their Project on the
IEEE Open Source Platform.
The pronoun they, or in its inflected forms (them, their, theirs, and themself),
should be used as a gender-neutral singular pronoun.
* Adhering to the governance rules established by the project IEEE Open Source Project
* 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.
## Stepping Down
......@@ -80,78 +88,72 @@ 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.
## Conduct
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.
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.
* 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)
### Communication
* Expectations on maintainer when communicating with other participants
## Organization of Project Materials
## Security and Critical vulnerabilities
### Group and Project
How an IEEE Open Source Project may use one group area (namespace) on the IEEE OPen Source Platform, although subgroups of that group are permitted.
An IEEE Open Source Project may organize there work into varoius different project areas within their designated group area.
* 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
### Repository
## Communication
Each open source project area that makes use of a git repository shall have the following files:
## Naming, Branding, Trademark, and Tradename
* README
* LICENSE
* NOTICES
* AUTHORS
* CONTRIBUTORS
* CONTRIBUTING (Governance and Code-of-Conduct)
IEEE Policy on Trademark applies to IEEE Open Source Projects.
### Licensing and legal notices
## Archiving
* README file notice and notice in header
* Draft standard notice
* How and when to move a project to an archived project
## Release and distributions
## Version
* Project release requirements
Informatoin for IEEE Open Source Project maintainers. DRAFT
## Critical vulnerabilities
Copyright 2019, The Maintainers Manual AUTHORS (see AUTHORS file)
.
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
### Process and Procedure
http://www.apache.org/licenses/LICENSE-2.0
.
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.
### Private notifications
.
## About This Document
### Public notifications
***In accordance with the Open Source Committee Operations Manual, all
IEEE Open Source Project Maintainers shall follow the requirements set
forth.***
.
This manual contains guidelines, advice, and requirements of interest
to anyone contributing to or participating in an IEEE Open Source
Project.
### Response and resolution time periods
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>.
* 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
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.
## Archiving
### Acknowledgements
* How and when to move a project to an archived project
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.
## Getting Help
{: .gitlab-red}
- Contact IEEE Open Source Community Manager
- Alternative contact (e.g., what they need to make a complaint about the OSCM).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment