Skip to content

[DEMO] Glossary is missing 'Repository' #63

Description

@pushpam2404

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

  • The term appears on the glossary page
  • Searching "repo" finds it
  • python3 -c "import json; json.load(open('data/glossary.json'))" runs clean
  • No existing entry was changed

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    difficulty: beginnerNo prior knowledge of the codebase neededdocumentationDocs, README, guidesgood first issueGreat for your very first pull request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions