├── LICENSE
└── README.md


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022 Eddie Jaoude
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Open Source Repo Checklist
 2 | 
 3 | What should YOUR Open Source repo have...
 4 | 
 5 | ## Highly recommended
 6 | 
 7 | - Repo settings
 8 |   - Description
 9 |   - URL (if appropriate)
10 |   - Topics
11 |   - Hide features not using (for example: wiki, packages)
12 | - README
13 |   - Screenshot / animated gif
14 |   - Prerequisite list
15 |     - hardware
16 |     - software
17 |   - Glossary of terms & acronyms
18 |   - QuickStart guide
19 |   - Where to get support / ask questions
20 | - Code of Conduct
21 | - License
22 | 
23 | ## Recommended
24 | 
25 | - README
26 |   - clear outcomes & needs for the project
27 |   - Audience targeted (skills, knowledge, experience)
28 | - Issue template
29 | - Pull Request template
30 | - GitHub Actions to automate repetitive tasks
31 | - Issue labels
32 | - Releases (create these manually or automatically using a GitHub Action)
33 | 
34 | # Nice to have
35 | 
36 | - Project board (to do, in progress, in review, done)
37 | 


--------------------------------------------------------------------------------