Skip to content

Glossary is missing '.gitignore' and 'README' #33

Open

Description

@pushpam2404

Context

Two files present in nearly every repository, including this one, and neither is explained anywhere on the site.

What to change

Files: data/glossary.json

Requirements:

  • Add one object for .gitignore and one for README
  • For .gitignore, mention that it is why __pycache__ never shows up in a pull request
  • For README, mention that it is the first thing a visitor reads
  • Keep entries sorted naturally — the page sorts them itself, so position in the file does not matter

Acceptance criteria

  • Both terms appear on the glossary page
  • The JSON still parses

How to verify locally

python3 -m http.server 8000

Then open http://localhost:8000.

Difficulty

Beginner.


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. You can also come to a PR Debug Clinic (Oct 12 or Oct 21).

Activity

  1. kw-1129 commented on Oct 23, 2026

    @kw-1129

    /claim

  2. github-actions commented on Oct 23, 2026

    @github-actions

    Assigned to @kw-1129. It is yours.

    Next steps

    1. Fork this repo and clone your fork
    2. git checkout -b fix/short-description
    3. Make the change, commit, push
    4. Open a PR with Closes #33 in the description

    If you get stuck, comment here saying what you have tried. If you change your mind, comment /unclaim — no hard feelings, that is genuinely fine.

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

Metadata

Metadata

Assignees

Labels

difficulty: beginnerNo prior knowledge of the codebase neededdocumentationDocs, README, guidesdomain: os-devxOpen Source & Developer Experiencegood first issueGreat for your very first pull requesthacktoberfestCounts toward Hacktoberfest 2026status: claimedAssigned to a contributor — do not start work on this

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions