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

Commit f7d10699 authored by Joshua Gay's avatar Joshua Gay 💾
Browse files

Makes section headers very descriptive in CONTRIBUTING.md

parent b2d93be8
Hello, and may we also say in advance, THANK YOU!
## How to contribute
If you are reading this, there is a good chance you are considering helping us
to improve this project, and we welcome your help, support, and feedback.
***CLA***: Contributors must obtain valid and applicable [CLA](https://opensource.ieee.org/community/cla/apache)
* Requirements to contribute - Submit a CLA
* When to create an issue vs just a merge request? - Big changes need an issue
* Project Governance - OSCom and IEEE SA Staff
* Additional guidance? - email or chat with us in our mattermost channel
## Requirements to contributes - Submit a CLA
All contributors must obtain valid and applicable [CLA](https://opensource.ieee.org/community/cla/apache)
number from the IEEE. Instructions for submitting a CLA are on the CLA document
itself (please do not share your CLA number with others).
If you wish to make a significant contribution, such as creating a new file
or set of files, then please make sure that all marge requests are associated
with one or more issues. If an issue does not exist, then please create one
that explains the general need, requirement, or problem you wish to solve.
Please note that when submitting a CLA to the IEEE, you can choose to have that
CLA be associated with: 1) a one time submission, 2) a specific project, or
3) for any project that requires that type of CLA.
## When to create an issue vs just a merge request? - Big changes need an issue
If you wish to submit an editorial change to one or more files, you can do so
by submitting a new merge request. You do not need to create a new issue
to go along with such merge requests.
We ask that when possible, please try to avoid submitting merge requests that
combine both editorial changes and more significant non-editorial changes or
additions. This makes it easier for us to more quickly and easily accept your
editorial changes.
## Governance
If you are submitting new material or making significant changes beyond what
would be considered editorial, then please link it to an existing or new issue
that explains the general idea behind why you think a significant change or
addition needs to be made.
## Project Governance - OSCom and IEEE SA Staff
This project is developed with oversight by the Open Source Committee
(OSCom) of the IEEE Standards Association Board of Governors. The chair of
......@@ -28,3 +52,19 @@ modify, or revise this manual with or without specific guidance. As a member
of the IEEE SA staff, the Open Source Community Manager will coordinate
with other staff members and/or consultants when developing/revising the
Maintainer's Manual.
## Additional guidance? - email or chat with us in our mattermost channel
If you are looking to contribute, but might need a little more help or guidance,
or something just isn't working for you with our platform, then
feel free to email our friendly [Open Source Community Manager](mailto:jgay@ieee.org). Please
include a link to this project, https://opensource.ieee.org/oscom/maintain, so that
we understand you are
or you can also if someone might be available in our [public mattermost channel](https://opensource-connect.ieee.org/oscom/channels/town-square).
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