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

Commit 17948cb3 authored by Joshua Gay's avatar Joshua Gay 💾
Browse files

Added project-setup guide

parent a2b5e851
## Setting up an Official IEEE Open Source Project
Your Official IEEE Open Source Project may contain one or more projects on opensource.ieee.org. Each project should contain the following files:
* README.md - Info about your project (see below for more detailed example)
* LICENSE - A copy of the project's license; this should be taken from the appropriate license file in https://opensource.ieee.org/community/cla/licenses
* AUTHORS.md - A list of copyright holders
* CONTRIBUTORS.md - A list of contributors
Additional files you may want to have or may need to have:
* NOTICES.md - Additional legal notices
* contributing.md - Policies for how you would like to accept contributions
* security.md - Policy on how to handle CVEs
## README
Your project's README file should provide at minimum information about your project, how to contribute (including license/CLA info), and who the project's lead and/or maintainers. Some additional sections and info are recommended. Below is a list of various recommended sections.
* About
* 1-2 paragraphs describing the purpose of the project
* Getting Started
* Requirements or preconditions needed to install the software or any assumptions.
* Instructions (step-by-step guide) to get a copy of the project up and running on a peron's local machine for use, development, and/or testing.
* Usage - any additional usage notes on using the software
* Project leadership
* Project Lead (username)
* Project maintainer name (username)
* Contributing
* This project is licensed under the terms of the (LICENSE NAME). Contributions are accepted under a Contributor License Agreement (LINK to appropriate project https://opensource.ieee.org/community/cla/). See (LINK to contributing.md) for more
* Communications
* Link to any mailing list
* Link to public mattermost channel
* Acknowledgements
* See CONTRIBUTORS.md for a list of contributors and AUTHORS.md for a list of authors.
* Any additional thanks, etc. you wish to add (e.g., another project that provided inspiration, etc).
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