Use the Submit a repo form. Please don't open a pull request that edits data/entries.json: the bot owns that file, and it only adds entries that come through the form.
When you submit, the bot checks two things.
Your account has to be at least 30 days old, with some public activity. You can submit up to 3 repos a week.
The repo has to:
- be at least 30 days old, with a push in the last 90 days;
- have an OSI-approved license (Learning & Resources also takes CC0-1.0, CC-BY-4.0 and CC-BY-SA-4.0), a real README and a description;
- have at least 2 of these 7 extras: a topic, a CONTRIBUTING guide, a code of conduct, an issue or pull request template, a SECURITY policy, GitHub Actions workflows, or a release.
If it passes, the bot opens a PR and the repo lands on its own. If it doesn't, the bot comments on your issue with the reasons. Fix them and submit again whenever you're ready.
Found spam, malware, a dead repo or something in the wrong category? Use the Report an entry form. Every report goes into the review queue.
The bots are Python 3.12 with the standard library only. The site is Astro, in site/.
-
Fork the repo and create a branch from
main. -
Make your change, with tests.
-
Run the checks:
python3 -m unittest discover -s scripts -t . npm --prefix site test npx prettier --check .
If prettier complains,
npx prettier --write <file>fixes the formatting. -
Open a pull request against
main.
We use Conventional Commits, for example fix(submit): reject repos with no README. Keep the subject to 72 characters or fewer. PRs are squash-merged and the PR title becomes the commit subject, so the title has to follow the same format.
Every pull request needs an approving review before it can merge, and the PR checks have to pass: validate, test, lint, site and the three CodeQL analyze jobs. If you're planning something big, open an issue or start a thread in Ideas first, so we can agree on the shape before you write the code.
Ask in Discussions Q&A. See SUPPORT.md for where everything else goes.
Everything you contribute is released under CC0.