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

project-setup.md 2.18 KB
Newer Older
Joshua Gay's avatar
Joshua Gay committed
1
2
## Setting up an Official IEEE Open Source Project

Joshua Gay's avatar
Joshua Gay committed
3
4
5
Your Official IEEE Open Source Project may contain one or more
projects on opensource.ieee.org. Each project should contain the
following files:
Joshua Gay's avatar
Joshua Gay committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19

* 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

Joshua Gay's avatar
Joshua Gay committed
20
21
22
23
24
Your project's README file should provide at minimum information about
your project, how to contribute (including license/CLA info), and a
list of the project's lead(s) and/or maintainer(s). Some additional
sections and info are recommended. Below is a list of various
recommended sections.
Joshua Gay's avatar
Joshua Gay committed
25

Joshua Gay's avatar
Joshua Gay committed
26
27
28
Also, have fun. Use emoji. Being friendly and welcoming. 

* :mag_right: About
Joshua Gay's avatar
Joshua Gay committed
29
  * 1-2 paragraphs describing the purpose of the project
Joshua Gay's avatar
Joshua Gay committed
30
31
32
33
34

* :checkered_flag: Getting Started
 * :hammer_and_wrench:	Requirements or preconditions needed to install the software or any assumptions.  
 * :page_with_curl: 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.

Joshua Gay's avatar
Joshua Gay committed
35
* Usage - any additional usage notes on using the software
Joshua Gay's avatar
Joshua Gay committed
36
37

* :unicorn: Project leadership
Joshua Gay's avatar
Joshua Gay committed
38
39
 * Project Lead (username) 
 * Project maintainer name (username)
Joshua Gay's avatar
Joshua Gay committed
40
41

* :gift: :tada: Contributing   
Joshua Gay's avatar
Joshua Gay committed
42
 * 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
Joshua Gay's avatar
Joshua Gay committed
43
44

* :speech_balloon: Communicating
Joshua Gay's avatar
Joshua Gay committed
45
46
 * Link to any mailing list
 * Link to public mattermost channel
Joshua Gay's avatar
Joshua Gay committed
47

Joshua Gay's avatar
Joshua Gay committed
48
49
50
51
52
53
54
55
* 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).