Add the 1.0 release notes to README and HISTORY - #3
Merged
Conversation
The repo is public and CI is green, so 1.0 is the first public release and both files now say what it contains. `version.json` already declared 1.0, and NBGV computes the tag from it on a dispatch from `main`. HISTORY.md replaces its placeholder with a real entry, keeping the fleet shape of a version heading and a nested list. README carries the short summary the README structure asks for, three bullets, with the full list left to HISTORY. Both state the thing a reader would otherwise assume wrongly: the site is not yet serving its public address, so 1.0 is the source and its pipeline, not the cutover. Releasing without saying that would read as the migration being finished. Adds "cutover" to cspell.json, since it now appears in the two files the spell gate actually covers. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR documents the repository’s first public release (v1.0) by adding a short release summary to README.md and a detailed v1.0 entry to HISTORY.md, plus updating the spelling dictionary for the new terminology used in those notes.
Changes:
- Add v1.0 release-note summary bullets to
README.md. - Replace
HISTORY.md’s placeholder with a detailed v1.0 entry using the project’s nested-list structure. - Add
cutovertocspell.jsonto avoid spell-check failures on the new release text.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a concise v1.0 release-note summary and points readers to the full history. |
| HISTORY.md | Adds the full v1.0 release entry (content/pipeline scope and URL-contract/CI details). |
| cspell.json | Whitelists the new term cutover used in the release notes. |
The line read `**Version: 1.0**:`, with a colon inside the bold and another after it, which renders as a double colon. The sibling line `**Summary**:` already puts the colon outside, so the two were inconsistent with each other as well. Now `**Version**: 1.0`, matching the sibling and the plain `Version 1.0:` form used in HISTORY.md. Raised by Copilot on this pull request. The construction was inherited from the hub's own README, which carries the same double colon, and spec/readme-structure.md does not mandate that literal form, asking only for the current version and a short summary. README.md is repo-owned, so this is fixed here and reported upstream rather than worked around. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
ptr727
added a commit
to ptr727/ProjectTemplate
that referenced
this pull request
Aug 1, 2026
README.md opened the block as `**Version: 2.0**:`, with the colon both inside the bold and after it, so it renders as a double colon. Its own sibling line `**Summary**:` puts the colon outside. Found by Copilot on ptr727/Blog#3, the first pull request of the first repo to copy the shape, and reported by the Blog agent on #456. The Release Notes block is one a new repo copies by shape, so every adopter inherited a finding on its first review. Same reasoning as the dotfile comment sweep: the files a new repo copies first teach it the shape, so a defect there propagates by construction. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The repo is public and CI is green, so 1.0 is the first public release and both files now say what it contains.
version.jsonalready declared1.0, and NBGV computes the tag from it on a dispatch frommain.HISTORY.mdreplaces its placeholder with a real entry, keeping the fleet shape of a version heading and a nested list.README.mdcarries the short summary the README structure asks for, three bullets, with the full list left toHISTORY.md.Both state the thing a reader would otherwise assume wrongly: the site is not yet serving its public address, so 1.0 is the source and its pipeline, not the cutover. Releasing without saying that would read as the migration being finished.
Adds
cutovertocspell.json, since it now appears in the two files the spell gate actually covers.