diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 9eb64ad..14bb4b4 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,7 +2,7 @@ blank_issues_enabled: false contact_links: - name: Chat with other players on Signal url: https://signal.group/#CjQKIJwvEt5fYt1pvw7J2pV664CyUyGJXmAJLV8ia3nUdAD7EhA_FzdxflEzkNmcvDHdVgLQ - about: Questions, screenshots, ideas you're not sure about yet, or just peering-policy flame wars. Bugs and concrete feature requests still go here as issues. + about: Screenshots, chat and peering-policy flame wars. Bugs, ideas and anything meaningful still go here as issues. - name: How the internet really works url: https://tkjaer.github.io/how-the-internet-works/ about: Curious how the real thing works? This interactive map explains it far better than any game. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75bd26d..aaeb19f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,8 +16,9 @@ lets us load your exact network. One topic per issue, please. Ideas are best when they say what happens in real networks and how that could become a fun mechanic. -Not sure yet whether something is a bug or an idea worth an issue? Ask in the -[Signal group](https://signal.group/#CjQKIJwvEt5fYt1pvw7J2pV664CyUyGJXmAJLV8ia3nUdAD7EhA_FzdxflEzkNmcvDHdVgLQ) first. Other players and the maintainer hang out there. +The [Signal group](https://signal.group/#CjQKIJwvEt5fYt1pvw7J2pV664CyUyGJXmAJLV8ia3nUdAD7EhA_FzdxflEzkNmcvDHdVgLQ) is for hanging out with other players, not for +reports: anything meaningful (a bug, an idea, a balance problem) goes into an issue, +even if you first mentioned it in the chat. Things said only in Signal get lost. ## Development diff --git a/README.md b/README.md index 820f3cc..a1a41a1 100644 --- a/README.md +++ b/README.md @@ -89,79 +89,24 @@ language loader in `src/index.html`). Missing translations fall back to English, breaks the game; `npm run i18n:check` lists what needs translating, and the tests make sure every translation keeps its `{placeholders}`, HTML tags and plural forms. -## Releasing - -Only published releases reach [seriesoftub.es](https://seriesoftub.es). Ordinary -pushes to `main` run CI and nothing else; a version bump is the release button. - -1. Bump `version` in `package.json` (semver) and rename the changelog's - `[Unreleased]` section to `## [] — `. Write the bullets for - players: the build turns that section into the in-game "What's new" card and - into `/version.json`, which open games poll to offer a reload. -2. Push or merge to `main`. - -The **Auto-release** workflow then runs the tests, tags `v`, publishes a -GitHub release with that changelog section as notes, and starts the deploy. It -does nothing when the tag already exists, and refuses a version older than the -latest release or one without changelog notes. A version with a pre-release -suffix (`1.2.0-beta.1`) becomes a pre-release and is not deployed. You can still -publish a release by hand; the deploy runs the same way. - -The release workflow checks that the tag matches `package.json`, runs the tests, -builds, deploys to GitHub Pages and pings IndexNow. It refuses to build when the -CHANGELOG has no `## []` section (rename `[Unreleased]` first). -Pre-releases never deploy, also not when run by hand, and a version older than -the live one is refused unless you tick `allow_older` (a deliberate rollback). -To redeploy an existing release, run the workflow manually with its tag. - -## Hosting setup - -GitHub Pages serves the site with **Source: GitHub Actions** and the custom domain -`seriesoftub.es`. Releases deploy from tags, so in **Settings → Environments → -github-pages → Deployment branches and tags**, add a tag rule for `v*` (by default -only the default branch may deploy). DNS for the apex domain: - -``` -seriesoftub.es. A 185.199.108.153 -seriesoftub.es. A 185.199.109.153 -seriesoftub.es. A 185.199.110.153 -seriesoftub.es. A 185.199.111.153 -seriesoftub.es. AAAA 2606:50c0:8000::153 -seriesoftub.es. AAAA 2606:50c0:8001::153 -seriesoftub.es. AAAA 2606:50c0:8002::153 -seriesoftub.es. AAAA 2606:50c0:8003::153 -www.seriesoftub.es. CNAME fjaeckel.github.io. -stats.seriesoftub.es. CNAME seocho.jc-ix.net. -``` - -Once DNS resolves, enable **Enforce HTTPS** in the repository's Pages settings. - -## Analytics - -The game uses [Ridiculytics](https://github.com/fjaeckel/ridiculytics): cookieless, -no persistent identifiers, self-hosted at `stats.seriesoftub.es`. It only reports -from `seriesoftub.es` itself; local copies, previews and forks stay silent. The -script is pinned to `ridiculytics@1.0.1` with an SRI hash. - -Besides page views and session length, the game sends a few coarse events, all -under the collector's 50-name cap: `game_new`, `game_continue`, `play_1m` … -`play_120m` (active, unpaused play time), `goal_`, `level_2`–`level_4`, -`game_year_2/3/5`, `win_tier1` and `bankrupt`. - -The collector must allow the site, e.g. in `sites.yaml`: - -```yaml -sites: - - domain: seriesoftub.es - origins: ["https://seriesoftub.es", "https://www.seriesoftub.es"] -``` - ## Community Come hang out in the **[Series of Tubes Signal group](https://signal.group/#CjQKIJwvEt5fYt1pvw7J2pV664CyUyGJXmAJLV8ia3nUdAD7EhA_FzdxflEzkNmcvDHdVgLQ)**. Share screenshots of your -network, report bugs, suggest cities, and argue about peering policy with other players. +network, suggest cities, and argue about peering policy with other players. There are fewer backhoes there than in the real thing. +Signal is for chatting. Bugs, feature requests and anything else that should not get +lost go into a **[GitHub issue](https://github.com/fjaeckel/seriesoftubes/issues/new/choose)**. + +## Star history + + + + + Star history of Series of Tubes + + + ## Contributing Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md). Everyone taking part follows the [Code of Conduct](CODE_OF_CONDUCT.md): be excellent to each other.