Professional Documents
Culture Documents
Level 1 Level 1: Readme
Level 1 Level 1: Readme
Level 1 Level 1: Readme
B y Eddie Jaoude
STEP 1
README LEVEL
This is the most important file in your project! It is the first file
everyone will see because it is previewed on your repo landing
page. Make sure you include: pre-requisites, quickstart,
screenshots. 1
STEP 2
LEVEL LICENSE
1
If you do not have a license your project is NOT Open Source.
There are many great licenses to pick from; two popular licenses
are MIT and GPLv3
Visit http://choosealicense.com
STEP 3
DESCRIPTION, URL, TOPICS LEVEL
The repo has settings for description, url and topics. Make sure to
use these fields and keep them concise and relevant.
1
LEVEL STEP 4
RELEASES, PACKAGES, ENVIRONMENTS
These are super useful sections if you use them. If you are not
STEP 1
ISSUES LEVEL
Even if you are the only person working on the project at the
moment, use the issues section. This will help you organise the
project and allow community members to understand what is
happening on the project. 1
STEP 2
LEVEL COMMITS
STEP 3
RELEASES, TAGS LEVEL
It is important to create read only check points for your project,
aka release / tag. These can also include features and bugs fixes
that are contained in that release.
2
LEVEL STEP 4
GITHUB ACTIONS (BEGINNER)
Automation sounds scary, but you can get the benefits