From 87b33268862488ba707d9ee3b530fa4089e9d2ef Mon Sep 17 00:00:00 2001
From: Nyle Garcia
Date: Mon, 16 Nov 2026 21:29:51 -0600
Subject: [PATCH 1/3] feat: footer Report and Patreon links, versions, release
tooling
- Footer: Patreon link beside Coffee; Report opens the GitHub issue chooser;
About panel shows the Snares version and commit and links the source.
- release-please for semver releases; CI, PR-title, CodeQL workflows;
Dependabot; issue and PR templates. Pages deploys from main only.
---
.github/ISSUE_TEMPLATE/bug.yml | 28 +++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 1 +
.github/ISSUE_TEMPLATE/idea.yml | 16 +++++++++
.github/dependabot.yml | 22 ++++++++++++
.github/pull_request_template.md | 8 +++++
.github/workflows/ci.yml | 27 +++++++++++++++
.github/workflows/codeql.yml | 24 +++++++++++++
.github/workflows/pages.yml | 13 +++----
.github/workflows/pr-title.yml | 17 ++++++++++
.github/workflows/release.yml | 29 ++++++++++++++++
.release-please-manifest.json | 1 +
README.md | 9 +++++
docs/changelog.md | 12 ++++++-
.../star-citizen-fankit-compliance.md | 2 +-
release-please-config.json | 11 ++++++
src/components/Policies.tsx | 2 +-
src/components/SiteFooter.tsx | 34 ++++++++++++++++---
src/globals.d.ts | 3 ++
src/lib/support.test.ts | 18 ++++++++++
src/lib/support.ts | 12 +++++++
src/styles.css | 21 ++++++++++++
vite.config.ts | 9 +++++
22 files changed, 304 insertions(+), 15 deletions(-)
create mode 100644 .github/ISSUE_TEMPLATE/bug.yml
create mode 100644 .github/ISSUE_TEMPLATE/config.yml
create mode 100644 .github/ISSUE_TEMPLATE/idea.yml
create mode 100644 .github/dependabot.yml
create mode 100644 .github/pull_request_template.md
create mode 100644 .github/workflows/ci.yml
create mode 100644 .github/workflows/codeql.yml
create mode 100644 .github/workflows/pr-title.yml
create mode 100644 .github/workflows/release.yml
create mode 100644 .release-please-manifest.json
create mode 100644 release-please-config.json
create mode 100644 src/globals.d.ts
create mode 100644 src/lib/support.test.ts
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
new file mode 100644
index 0000000..c6ac5ce
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,28 @@
+name: Something is wrong
+description: A wrong position, a wrong number, or the page misbehaving.
+labels: [bug]
+body:
+ - type: textarea
+ id: what
+ attributes:
+ label: What happened
+ description: What you did, what you saw, and what you expected instead.
+ validations:
+ required: true
+ - type: input
+ id: plan
+ attributes:
+ label: Plan link
+ description: Copy the page address with the plan open. The whole plan is in the link.
+ placeholder: https://snare.starorg.tools/#...
+ - type: input
+ id: version
+ attributes:
+ label: Version
+ description: Shown in the footer under More, with the game build.
+ placeholder: v0.2.0 · game build 4.x
+ - type: input
+ id: browser
+ attributes:
+ label: Browser and device
+ placeholder: Firefox on Windows, Chrome on Android...
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..0086358
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/idea.yml b/.github/ISSUE_TEMPLATE/idea.yml
new file mode 100644
index 0000000..6800611
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/idea.yml
@@ -0,0 +1,16 @@
+name: Idea
+description: Something Snares should do, or do better.
+labels: [enhancement]
+body:
+ - type: textarea
+ id: idea
+ attributes:
+ label: The idea
+ description: What you want to do in the game that the planner does not help with yet.
+ validations:
+ required: true
+ - type: textarea
+ id: checked
+ attributes:
+ label: Seen in the game
+ description: If this rests on how the game behaves, say what you saw and in which build.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000..2e76bf3
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,22 @@
+version: 2
+updates:
+ - package-ecosystem: npm
+ directory: /
+ schedule:
+ interval: weekly
+ commit-message:
+ prefix: chore
+ include: scope
+ groups:
+ npm:
+ patterns: ["*"]
+ update-types: [minor, patch]
+ - package-ecosystem: github-actions
+ directory: /
+ schedule:
+ interval: weekly
+ commit-message:
+ prefix: ci
+ groups:
+ actions:
+ patterns: ["*"]
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..2dd4109
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,8 @@
+
+
+## What and why
+
+## Checked
+
+- [ ] `npm test` and `npm run build` pass
+- [ ] `docs/changelog.md` has an entry (anything a user would notice)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 0000000..9a23bd2
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,27 @@
+name: CI
+
+on:
+ pull_request:
+ # Release PRs are opened by a workflow, which starts no other workflow; the release workflow asks for this run itself.
+ workflow_dispatch:
+
+permissions:
+ contents: read
+
+concurrency:
+ group: ci-${{ github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ check:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v7
+ - uses: actions/setup-node@v7
+ with:
+ node-version: 24
+ cache: npm
+ - run: npm ci
+ - run: npm run typecheck
+ - run: npm test
+ - run: npx vite build
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
new file mode 100644
index 0000000..465447d
--- /dev/null
+++ b/.github/workflows/codeql.yml
@@ -0,0 +1,24 @@
+name: CodeQL
+
+on:
+ push:
+ branches: [main]
+ pull_request:
+ schedule:
+ - cron: "23 5 * * 1"
+
+permissions:
+ contents: read
+
+jobs:
+ analyze:
+ runs-on: ubuntu-latest
+ permissions:
+ security-events: write
+ steps:
+ - uses: actions/checkout@v7
+ - uses: github/codeql-action/init@v4
+ with:
+ languages: javascript-typescript,actions
+ build-mode: none
+ - uses: github/codeql-action/analyze@v4
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
index 58fceab..ef7529e 100644
--- a/.github/workflows/pages.yml
+++ b/.github/workflows/pages.yml
@@ -3,35 +3,32 @@ name: Deploy to GitHub Pages
on:
push:
branches: [main]
- pull_request:
workflow_dispatch:
permissions:
contents: read
concurrency:
- group: pages-${{ github.ref }}
+ group: pages
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
- - uses: actions/setup-node@v4
+ - uses: actions/checkout@v7
+ - uses: actions/setup-node@v7
with:
node-version: 24
cache: npm
- run: npm ci
- run: npm test
- run: npm run build
- - uses: actions/upload-pages-artifact@v3
- if: github.event_name != 'pull_request'
+ - uses: actions/upload-pages-artifact@v5
with:
path: dist
deploy:
- if: github.event_name != 'pull_request'
needs: build
runs-on: ubuntu-latest
permissions:
@@ -42,4 +39,4 @@ jobs:
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
- uses: actions/deploy-pages@v4
+ uses: actions/deploy-pages@v5
diff --git a/.github/workflows/pr-title.yml b/.github/workflows/pr-title.yml
new file mode 100644
index 0000000..3863afd
--- /dev/null
+++ b/.github/workflows/pr-title.yml
@@ -0,0 +1,17 @@
+name: PR title
+
+on:
+ pull_request:
+ types: [opened, edited, reopened, synchronize]
+
+permissions:
+ pull-requests: read
+
+jobs:
+ conventional:
+ runs-on: ubuntu-latest
+ steps:
+ # Pull requests are squashed, so the title becomes the commit the next version is worked out from.
+ - uses: amannn/action-semantic-pull-request@v6
+ env:
+ GITHUB_TOKEN: ${{ github.token }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 0000000..b79fe7a
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,29 @@
+name: Release
+
+on:
+ push:
+ branches: [main]
+
+permissions:
+ contents: read
+
+concurrency:
+ group: release
+ cancel-in-progress: false
+
+jobs:
+ release-please:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ pull-requests: write
+ actions: write
+ steps:
+ - id: release
+ uses: googleapis/release-please-action@v5
+ # A pull request opened with the workflow token starts no checks, and main requires them.
+ - if: steps.release.outputs.prs_created == 'true'
+ env:
+ GH_TOKEN: ${{ github.token }}
+ BRANCH: ${{ fromJSON(steps.release.outputs.pr).headBranchName }}
+ run: gh workflow run ci.yml --repo "$GITHUB_REPOSITORY" --ref "$BRANCH"
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
new file mode 100644
index 0000000..9d957c7
--- /dev/null
+++ b/.release-please-manifest.json
@@ -0,0 +1 @@
+{ ".": "0.1.0" }
diff --git a/README.md b/README.md
index 0954ad1..8fb6598 100644
--- a/README.md
+++ b/README.md
@@ -77,6 +77,15 @@ sc-gamedata output directory.
One-time setup in the GitHub repo: Settings → Pages → Source: **GitHub Actions**.
The build uses relative asset paths, so it works under any repo name.
+## Contributing and releases
+
+- Bugs and ideas: [open an issue](https://github.com/voidput/snares/issues/new/choose). The site footer links there too.
+- `main` is protected: changes land by pull request, squashed, once the `check` job (typecheck, tests, build) is green. Org admins can bypass.
+- Pull request titles are conventional commits (`feat: ...`, `fix: ...`, `docs: ...`); the title becomes the commit.
+- Versions follow semver and are cut by [release-please](https://github.com/googleapis/release-please): it keeps a release pull request open that bumps `package.json` and writes `CHANGELOG.md` from the commits (`fix` → patch, `feat` → minor, `!` → breaking; before 1.0 a breaking change bumps the minor). Merging it tags `vX.Y.Z` and publishes a GitHub Release. The footer shows the version and commit the page was built from.
+- `docs/changelog.md` stays the hand-written record of what changed for users; `CHANGELOG.md` is generated.
+- Other workflows: `ci.yml` (pull requests), `pr-title.yml`, `codeql.yml`, and Dependabot for npm and actions, weekly.
+
## How the position is found
Ships in quantum fly a straight line to the centre of their destination, so
diff --git a/docs/changelog.md b/docs/changelog.md
index 18f2f00..0683d3f 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -1,11 +1,21 @@
---
title: Changelog
tags: [changelog]
-updated: 2026-11-14
+updated: 2026-11-15
---
# Changelog
+## 2026-11-15 — Issue link, versions and a protected main
+
+Type: Added. Effort: L2.
+
+- Footer: **Patreon** link beside Coffee (StarOrg.tools page), same tip-link terms ([decision](decisions/star-citizen-fankit-compliance.md)).
+- Footer: **Report** opens the GitHub issue chooser (bug and idea forms); the About panel repeats it, links the source, and shows the Snares version and commit ([README](../README.md)).
+- Versions: semver through release-please. Conventional commits drive a release pull request that bumps `package.json` and writes `CHANGELOG.md`; merging it tags `vX.Y.Z` and publishes a GitHub Release. Baseline tag `v0.1.0`.
+- `main` is protected by a ruleset: no force-push, no deletion, pull request with a green `check` job, squash only. Org admins can bypass.
+- Workflows: `ci.yml` (typecheck, tests, build on pull requests), `release.yml`, `pr-title.yml`, `codeql.yml`; Dependabot weekly for npm and actions. Actions moved to current majors (Node 20 warnings gone). `pages.yml` now runs on `main` only.
+
## 2026-11-14 — A map with depth
Type: Added. Effort: L2.
diff --git a/docs/decisions/star-citizen-fankit-compliance.md b/docs/decisions/star-citizen-fankit-compliance.md
index 99ca6e3..8658e25 100644
--- a/docs/decisions/star-citizen-fankit-compliance.md
+++ b/docs/decisions/star-citizen-fankit-compliance.md
@@ -23,7 +23,7 @@ Snares is a public Star Citizen fan site built on data read from the game's file
## Tip link and referral code
-The page carries a Buy Me a Coffee link and an RSI referral code, as Bindscape and StarOrg.tools do. Recorded honestly, as there: the agreement allows no compensation *for access or use*. A voluntary tip that buys nothing is outside that wording but is the grey edge of "non-commercial", and CIG may see it differently. If asked, remove the tip link first. The referral code uses CIG's own programme.
+The page carries Buy Me a Coffee and Patreon links and an RSI referral code, as Bindscape and StarOrg.tools do. Recorded honestly, as there: the agreement allows no compensation *for access or use*. A voluntary tip that buys nothing is outside that wording but is the grey edge of "non-commercial", and CIG may see it differently. If asked, remove the tip links first. The referral code uses CIG's own programme.
## Consequences
diff --git a/release-please-config.json b/release-please-config.json
new file mode 100644
index 0000000..51048ad
--- /dev/null
+++ b/release-please-config.json
@@ -0,0 +1,11 @@
+{
+ "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+ "include-component-in-tag": false,
+ "bump-minor-pre-major": true,
+ "packages": {
+ ".": {
+ "release-type": "node",
+ "changelog-path": "CHANGELOG.md"
+ }
+ }
+}
diff --git a/src/components/Policies.tsx b/src/components/Policies.tsx
index 34c6902..bc5279d 100644
--- a/src/components/Policies.tsx
+++ b/src/components/Policies.tsx
@@ -45,7 +45,7 @@ export function PrivacyPolicy() {
Links that leave the site
- Coffee opens Buy Me a Coffee and Enlist opens robertsspaceindustries.com, each in a new tab. Nothing is sent to
+ Coffee opens Buy Me a Coffee, Patreon opens patreon.com, and Enlist opens robertsspaceindustries.com, each in a new tab. Nothing is sent to
them until you click, and what happens there falls under their policies.
diff --git a/src/components/SiteFooter.tsx b/src/components/SiteFooter.tsx
index 6fb828d..ef346f3 100644
--- a/src/components/SiteFooter.tsx
+++ b/src/components/SiteFooter.tsx
@@ -1,5 +1,5 @@
// The site footer, after RSI+'s: one slim always-visible row (Fankit mark, the "unofficial"
-// line, game build, Coffee, More) and a panel that unfolds upward with the full trademark
+// line, game build, Coffee, Patreon, More) and a panel that unfolds upward with the full trademark
// notice and the referral code.
//
// Star Citizen Fankit compliance (docs/decisions/star-citizen-fankit-compliance.md).
@@ -8,12 +8,12 @@
// sits in the bar at 40px, full opacity, with no filter, shadow or other effect;
// - a trademark notice of at least 10pt: the bar carries one line at 14px, and the
// full disclaimer is one click away in the panel, also at 14px.
-import { Check, ChevronDown, ChevronUp, Coffee, Copy, ExternalLink, ShieldCheck } from "lucide-react";
+import { Bug, Check, ChevronDown, ChevronUp, Coffee, Copy, ExternalLink, Heart, ShieldCheck } from "lucide-react";
import { useEffect, useRef, useState } from "react";
import { DISCLAIMER, MARK_ALT, MARK_SIZE, NOTICE_SIZE, SHORT_NOTICE } from "../brand/fankit";
import brandMark from "../brand/MadeByTheCommunity_White.png";
-import { BUYMEACOFFEE_URL, enlistUrl, REFERRAL } from "../lib/support";
+import { APP_VERSION, BUYMEACOFFEE_URL, enlistUrl, ISSUES_URL, PATREON_URL, REFERRAL, REPO_URL } from "../lib/support";
import { PrivacyPolicy, Terms } from "./Policies";
type View = "about" | "privacy" | "terms";
@@ -85,6 +85,17 @@ export function SiteFooter({ build, extracted }: { build: string; extracted?: st
(build {build}) for planning only. No game code, art or audio is included. Free to use: no paid features, no
ads, no accounts, no tracking.
+
+ Snares {APP_VERSION}. Found something wrong, or want it to do more?{" "}
+
+ Open an issue on GitHub
+ {" "}
+ (needs a GitHub account). The{" "}
+
+ source
+ {" "}
+ is there too.
+
Referral code
@@ -118,13 +129,28 @@ export function SiteFooter({ build, extracted }: { build: string; extracted?: st