This is a demonstration issue. It is deliberately tiny, so it can be
done start to finish in a couple of minutes. If you are brand new, these are
the ones to start with.
Context
The glossary defines fourteen terms but not the most basic one of all. Somebody reading it for the first time meets "repository" in almost every other entry without it ever being explained.
What to change
Files: data/glossary.json
Requirements:
- Add one object for Repository
short is a single sentence, written for somebody who has never used Git
full can mention that people shorten it to "repo"
- Add a
seeAlso array pointing at terms already in the file, such as Fork or Clone
- Position in the file does not matter — the page sorts them itself
Acceptance criteria
How to verify locally
python3 -c "import json; json.load(open('data/glossary.json'))"
python3 -m http.server 8000 # then open glossary.html
How long this takes
Three minutes. One small block of JSON. Watch the commas.
New here? Comment /claim on this issue and a bot will assign it to you. Then read CONTRIBUTING.md.
Stuck at any point? Comment here saying what you have tried and where it stopped working — that is not an admission of failure, it is how we find out the instructions were unclear.
Context
The glossary defines fourteen terms but not the most basic one of all. Somebody reading it for the first time meets "repository" in almost every other entry without it ever being explained.
What to change
Files:
data/glossary.jsonRequirements:
shortis a single sentence, written for somebody who has never used Gitfullcan mention that people shorten it to "repo"seeAlsoarray pointing at terms already in the file, such as Fork or CloneAcceptance criteria
python3 -c "import json; json.load(open('data/glossary.json'))"runs cleanHow to verify locally
How long this takes
Three minutes. One small block of JSON. Watch the commas.
New here? Comment
/claimon this issue and a bot will assign it to you. Then read CONTRIBUTING.md.Stuck at any point? Comment here saying what you have tried and where it stopped working — that is not an admission of failure, it is how we find out the instructions were unclear.