# Contributing to Series of Tubes Thanks for wanting to help build the cartoon internet. Bug reports, ideas, puns, translations and code are all welcome. ## Reporting bugs and ideas Open an issue on GitHub. For bugs, include what you did, what you expected and what happened. If it involves a game in progress, attach an export of your save (menu → Export), which lets us load your exact network. Ideas are best when they say what happens in real networks and how that could become a fun mechanic. ## Development The game is one static page, `site/index.html`, with no framework and no build step while developing. ```bash npm ci # installs jsdom for the tests npm run serve # builds and serves the game locally npm test # all tests must pass node scripts/i18n-check.js # translations must be complete ``` Opening `site/index.html` directly in a browser also works. A tour of the code is in [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md). ## Pull requests - Keep each pull request focused on one change, and target `main`. - Add or update a test in `tests/` for every feature or fix. Tests are seeded and must not depend on luck. - Add a bullet for players under `## [Unreleased]` in `CHANGELOG.md`, in plain English. Releases are cut by the maintainer. - Old saves must keep loading. New state needs a default for new games and a check in `sanitize()`. - Check your change on a phone-sized screen (about 360 px wide). Most players are on phones. ## House rules for content - **Every name is a pun.** No real company names for networks, vendors, cables, banks, data centers or exchanges. Real conference names (NANOG, RIPE, DENOG…) are fine. Please don't use lazy "-ish" names; find a proper pun or use a plain word. - **Accurate underneath the jokes.** Mechanics should be recognisable to a network engineer: exaggerated, not invented. - **Friendly humour.** Punch at technology, bureaucracy and ourselves, not at people. ## Translations Every player-facing string goes through `tr()`, `trn()` or `N_()`. Dictionaries live in `site/i18n/` (English text → translation). To add a language, copy `it.js`, translate the values, register the language in the language list in `site/index.html`, and run `node scripts/i18n-check.js ` until it reports nothing missing, unused or broken. ## License By contributing, you agree that your contributions are licensed under the [MIT License](LICENSE).