From 451e8a70a5d9540110d72b42c8b22c234ca597a9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Norman=20K=C3=B6hring?= <n+250@koehr.in>
Date: Fri, 3 Jan 2025 14:53:16 +0100
Subject: [PATCH] update README and add GitHub issue templates

---
 .github/ISSUE_TEMPLATE/bug-report.md         | 12 ++++++++++
 .github/ISSUE_TEMPLATE/cancel-membership.md  | 16 +++++++++++++
 .github/ISSUE_TEMPLATE/request-membership.md | 19 +++++++++++++++
 .github/ISSUE_TEMPLATE/suggestion.md         | 13 ++++++++++
 .github/ISSUE_TEMPLATE/update-membership.md  | 23 ++++++++++++++++++
 README.md                                    | 25 +++++++++++++-------
 6 files changed, 99 insertions(+), 9 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md
 create mode 100644 .github/ISSUE_TEMPLATE/cancel-membership.md
 create mode 100644 .github/ISSUE_TEMPLATE/request-membership.md
 create mode 100644 .github/ISSUE_TEMPLATE/suggestion.md
 create mode 100644 .github/ISSUE_TEMPLATE/update-membership.md

diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 00000000..61d53c54
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,12 @@
+---
+name: Report a bug
+about: You found an issue with the site itself?
+title: "[BUG REPORT] PLEASE ADD TITLE"
+labels: bug
+assignees: nkoehring
+---
+
+<!-- You found an issue with the site itself, not with a listed site? This is the place to report it! -->
+
+**What is wrong?**
+<!-- Please try to describe the issue as detailed as possible. You might want to include the current behaviour and how it differs from the behaviour you expect. -->
diff --git a/.github/ISSUE_TEMPLATE/cancel-membership.md b/.github/ISSUE_TEMPLATE/cancel-membership.md
new file mode 100644
index 00000000..26016936
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/cancel-membership.md
@@ -0,0 +1,16 @@
+---
+name: Cancel membership
+about: Request the removal of a site in the directory.
+title: "[SITE UPDATE] remove https://URL"
+labels: Membership Update
+assignees: nkoehring
+---
+
+<!-- If the URL of a page that you added needs to be removed, we will remove it. -->
+
+**Which URL are your requesting to remove?**
+https://
+
+**Proof that you initially requested the membership**
+<!-- Add a link to the original PR or Issue, that you used to request membership, so that I can make sure, you are allowed to remove it. -->
+
diff --git a/.github/ISSUE_TEMPLATE/request-membership.md b/.github/ISSUE_TEMPLATE/request-membership.md
new file mode 100644
index 00000000..9f6c02ac
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/request-membership.md
@@ -0,0 +1,19 @@
+---
+name: Request membership
+about: Request to add a site to the directory.
+title: "[SITE REQUEST] https://PLEASE_ADD_URL"
+labels: Membership Request
+assignees: nkoehring
+---
+
+<!-- Make sure to check the README before requesting membership. Everyone can submit a page, but not everyone will be accepted, sorry. -->
+
+**Which URL are your requesting to add?**
+https://
+
+**Is the download size of the site you are adding smaller than 256kB in total?**
+<!-- The easiest way to check is, to open the network inspector in an incognito tab -->
+[] Yes, I checked the size requirements.
+
+**What makes the site valuable, except for its small size?**
+<!-- Please think about the value, the requested site adds. Is it your digital home that might inspire others to create their own? Is it informative? Is it showcasing something? -->
diff --git a/.github/ISSUE_TEMPLATE/suggestion.md b/.github/ISSUE_TEMPLATE/suggestion.md
new file mode 100644
index 00000000..c6224d21
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/suggestion.md
@@ -0,0 +1,13 @@
+---
+name: Feature Proposal
+about: Request something that could enhance the club experience.
+title: "[FEATURE PROPOSAL] PLEASE ADD TITLE"
+labels: enhancement
+assignees: nkoehring
+---
+
+<!-- You want to make the club experience better or have an idea how? -->
+
+**Proposal**
+<!-- Please try to describe the proposal as detailed as possible. -->
+
diff --git a/.github/ISSUE_TEMPLATE/update-membership.md b/.github/ISSUE_TEMPLATE/update-membership.md
new file mode 100644
index 00000000..ff653f29
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/update-membership.md
@@ -0,0 +1,23 @@
+---
+name: Update membership
+about: Request an update to a site in the directory.
+title: "[SITE UPDATE] https://OLD_URL to https://NEW_URL"
+labels: Membership Update
+assignees: nkoehring
+---
+
+<!-- If the URL of a page that you added changed, this is the right place to ensure that it stays in the club! -->
+
+**Which URL are your requesting to change?**
+https://
+
+**What is the new URL?**
+https://
+
+**Is the download size of the site still smaller than 256kB in total?**
+<!-- The easiest way to check is, to open the network inspector in an incognito tab -->
+[] Yes, I (re)checked the size requirements.
+
+**Is the site still valuable?**
+<!-- Please think about the value, the site adds. Did it change? -->
+
diff --git a/README.md b/README.md
index ee0b3518..ac3b5fd0 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,21 @@ Of course, the absolute size of a website is not a perfect indicator. A page mig
 
 ## Adding a web page
 
-Please send a patch or pull request. If unsure, you can also write a ticket mentioning the website(s). The website(s) will be added after passing the review and measured for changes about once every week.
+~~Please send a patch or pull request.~~ Please write an issue/ticket mentioning the website(s). The website(s) will be added after passing the review. Content checks are repeated in irregular intervals.
+
+If you read this on Github, use the corresponding [issue template for requesting membership](https://github.com/nkoehring/250kb-club/issues/new?assignees=nkoehring&labels=Membership%20Request&projects=&template=request-membership.md&title=%5BSITE+REQUEST%5D%20https%3A%2F%2FPLEASE_ADD_URL).
+
+## Updating a web page
+
+Please write an issue/ticket mentioning which URL should be updated to what.
+
+If you read this on Github, use the corresponding [issue template for updating an URL](https://github.com/nkoehring/250kb-club/issues/new?assignees=nkoehring&labels=Membership%20Update&projects=&template=update-membership.md&title=%5BSITE+UPDATE%5D%20https%3A%2F%2FOLD_URL%20to%20https%3A%2F%2FNEW_URL).
+
+## Removing a web page
+
+Please write an issue/ticket mentioning which URL should be removed and add a proof that it was you who initially requested to add it.
+
+If you read this on Github, use the corresponding [issue template for removing an URL](https://github.com/nkoehring/250kb-club/issues/new?assignees=nkoehring&labels=Membership%20Update&projects=&template=cancel-membership.md&title=%5BSITE+UPDATE%5D%20remove%20https%3A%2F%2FURL).
 
 ## What are those values?
 
@@ -29,14 +43,8 @@ is 60%. The rest are extras like CSS, JavaScript and so on. It is hard to
 say what a good ratio is but my gut feeling is that everything above 20% is
 pretty good already.
 
-## All shiny
-
-This page got completely rebuild and several issues of the old version got solved. It now has pagination (100 pages per... well, page) and detail pages for every entry that you can link to.
-
 ## Hacking this page
 
-[![status-badge](https://ci.k0r.in/api/badges/1/status.svg)](https://ci.k0r.in/repos/1)
-
 This page needs three components to work:
 
 ### [Deno](https://deno.land/)
@@ -60,5 +68,4 @@ mkdir -m a+rwx yltresults # for access to YLT results
 
 And build the page with `yarn build`.
 
-The website analysis is done by `compile-list.js` which reads `pages.txt` and
-writes the results to `src/components/pages.mjs`. `pages.txt` is curated by hand.
+The website analysis functionality is implemented in `analyser/metrics.ts`, everything else either in `analyser/toolkit.ts`, `index.ts` or the corresponding Zola templates. Results are written as TOML front matter to `content/:page-slug:.md` and rendered by Zola in a later step. `pages.txt` is curated by hand.