Contributing

Use the issue forms to suggest a resource or report a problem. Please use issues for resource suggestions rather than pull requests.

For a suggestion, include the track, concept, URL, and what it improves over the current step. Resources must be free to read or watch. Link one specific video, paper, article, or chapter. Course homepages, semester playlists, other resource lists, paid material, and DSA/interview content are outside this catalog’s scope.

For a problem, include the track and step, what happened, and what you expected. Reports about missing prerequisites or confusing step order are welcome alongside broken links and paywalls.

Repository checks

The track tables and README Contents define the published catalog. After adding or editing a track, run:

ruby scripts/catalog.rb --write
ruby scripts/catalog.rb
python3 -m unittest discover -s scripts/tests

The first command updates counts, sidebar entries, page descriptions, and queue checkboxes. The second checks that those agree and that each published track has 5–15 numbered steps with valid link syntax. These checks do not verify remote availability or teaching quality; review the resources separately.

The Pages workflow runs these checks, builds Jekyll, removes raw Markdown copies, and checks the resulting HTML before deployment. With Jekyll and the plugins in _config.yml installed, the same build can be checked locally:

jekyll build --destination /tmp/roadmaps-site
find /tmp/roadmaps-site -name '*.md' -delete
python3 scripts/check_site.py /tmp/roadmaps-site

The website adds a search box above Contents and a collapsible track menu on small screens. Search uses the names and descriptions already in the Contents table. All tracks and links remain available without JavaScript. When changing the layout, check search results, the empty state, Clear, mobile menu open/close, Escape, keyboard focus, and a track’s resource links.

The test suite also checks text contrast in light and dark modes. The built-site check covers all published pages, including the 404 page, internal anchors, image metadata, accessibility references, and private-file exclusions. Pull requests run the same validation as pushes. Deployment runs only from main.