Skip to content

Commit 715bdf5

Browse files
hhkaosclaude
andcommitted
Comment out README badges by default
A broken badge is a fine nudge in an organizer's own fork, but it also made both the template's own README and every freshly forked one look broken before anyone had a chance to configure anything — including when just browsing the template repo to decide whether to fork it. Ship them as an HTML comment instead, with a new setup step (9) telling organizers where to uncomment and edit them. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016oBwXtyuMrATqZcKPgn8hc
1 parent 591178b commit 715bdf5

3 files changed

Lines changed: 20 additions & 6 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ this file versions the template repo (dashboard, workflows, docs), the spec
2020
versions the data format. A template release never implies a schema bump, or
2121
the other way around.
2222

23+
## [0.4.1] - 2026-08-07
24+
25+
### Fixed
26+
- The three README badges added in 0.4.0 now ship commented out instead of
27+
rendering broken by default: a broken badge is a fine nudge in your own
28+
fork, but it also made both the template's own README and every freshly
29+
forked one look broken before anyone had a chance to configure anything.
30+
Setup step 9 tells you where to uncomment and edit them.
31+
2332
## [0.4.0] - 2026-08-07
2433

2534
### Added

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# OTE Template
22

3+
<!--
4+
Uncomment these once you've finished the setup below, replacing
5+
your-user/your-repo with your fork (and the Pages URL in the third one):
6+
37
[![Validate](https://github.com/your-user/your-repo/actions/workflows/validate.yml/badge.svg)](https://github.com/your-user/your-repo/actions/workflows/validate.yml)
48
[![Publish](https://github.com/your-user/your-repo/actions/workflows/publish.yml/badge.svg)](https://github.com/your-user/your-repo/actions/workflows/publish.yml)
59
[![OTE spec](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fyour-user.github.io%2Fyour-repo%2Ffeed.json&query=%24.specVersion&label=OTE%20spec&color=blue)](https://opentechevents.org/spec/)
6-
7-
Replace `your-user/your-repo` in the three badge URLs above with your fork
8-
(and the Pages URL in the third one) once you've finished the setup below —
9-
until then they point at nothing and render broken, which is your reminder
10-
to come back and fix them.
10+
-->
1111

1212
Fork this repository and get, with nothing but GitHub and GitHub Pages:
1313

@@ -141,6 +141,11 @@ Add your community to the adopters list in
141141
[opentechevents-spec](https://github.com/OpenTechEvents/opentechevents-spec) so
142142
directories and users can find your feed.
143143

144+
### 9. Turn on the README badges (optional)
145+
146+
Near the top of this file, uncomment the `Validate`/`Publish`/`OTE spec`
147+
badges and replace `your-user/your-repo` with your fork.
148+
144149
## Editing events
145150

146151
Phase 1 is hand-edited JSON — the workflows validate every push and pull

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.4.0
1+
0.4.1

0 commit comments

Comments
 (0)