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 contributor wall currently has one entry. Adding yourself is the gentlest possible first pull request — one small new file, no code, and your name appears on the live site within a minute of merging.
What to change
Files: contributors/<your-github-username>.json (a new file)
Requirements:
- Copy
contributors/_TEMPLATE.json to contributors/<your-username>.json
- Use your exact GitHub username as the filename — lower case, no spaces
- Fill in
name, github, and optionally quote and interests
- Do not edit
contributors/index.json — a robot rebuilds that after merge
- Do not touch anybody else's file
Acceptance criteria
How to verify locally
python3 scripts/build_contributors.py --check
python3 -m http.server 8000 # then open the wall page
How long this takes
Two minutes. No code, no prior knowledge. This is the one to try first.
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 contributor wall currently has one entry. Adding yourself is the gentlest possible first pull request — one small new file, no code, and your name appears on the live site within a minute of merging.
What to change
Files:
contributors/<your-github-username>.json(a new file)Requirements:
contributors/_TEMPLATE.jsontocontributors/<your-username>.jsonname,github, and optionallyquoteandinterestscontributors/index.json— a robot rebuilds that after mergeAcceptance criteria
contributors/<your-username>.jsonpython3 scripts/build_contributors.py --checkpassesHow to verify locally
python3 scripts/build_contributors.py --check python3 -m http.server 8000 # then open the wall pageHow long this takes
Two minutes. No code, no prior knowledge. This is the one to try first.
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.