Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .skillshare/registry.yaml

This file was deleted.

8 changes: 8 additions & 0 deletions .skillshare/skills/.metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"version": 1,
"entries": {
"mdproof": {
"source": "github.com/runkids/mdproof/skills"
}
}
}
84 changes: 45 additions & 39 deletions .skillshare/skills/skillshare-changelog/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ metadata:

Generate a CHANGELOG.md entry for a release. $ARGUMENTS specifies the tag version (e.g., `v0.16.0`) or omit to auto-detect via `git describe --tags --abbrev=0`.

**Scope**: This skill updates `CHANGELOG.md` and syncs the website changelog (`website/src/pages/changelog.md`). It does NOT generate RELEASE_NOTES, update version numbers, or handle the full release workflow — use `/release` for that.
**Scope**: This skill updates `CHANGELOG.md` and syncs the website changelog (`website/src/pages/changelog.md`). It does NOT generate RELEASE\_NOTES, update version numbers, or handle the full release workflow — use `/release` for that.

## Workflow

Expand All @@ -42,15 +42,15 @@ git log "${PREV_TAG}..${LATEST_TAG}" --oneline --no-merges

Group commits by conventional commit type:

| Prefix | Category |
|--------|----------|
| `feat` | New Features |
| `fix` | Bug Fixes |
| `refactor` | Refactoring |
| `docs` | Documentation |
| `perf` | Performance |
| `test` | Tests |
| `chore` | Maintenance |
| Prefix | Category |
| ---------- | ------------- |
| `feat` | New Features |
| `fix` | Bug Fixes |
| `refactor` | Refactoring |
| `docs` | Documentation |
| `perf` | Performance |
| `test` | Tests |
| `chore` | Maintenance |

### Step 4: Read Existing Entries for Style Reference

Expand All @@ -61,30 +61,34 @@ Before writing, read the most recent 2-3 entries in `CHANGELOG.md` to match the
Write from the **user's perspective**. Only include changes users will notice or care about.

**Include**:
- New features with usage examples (CLI commands, code blocks)
- Bug fixes that affected user-visible behavior
- Breaking changes (renames, removed flags, scope changes)
- Performance improvements users would notice

* New features with usage examples (CLI commands, code blocks)
* Bug fixes that affected user-visible behavior
* Breaking changes (renames, removed flags, scope changes)
* Performance improvements users would notice

**Exclude**:
- Internal test changes (smoke tests, test refactoring)
- Implementation details (error propagation, internal structs)
- Dev toolchain changes (Makefile cleanup, CI tweaks)
- Pure documentation adjustments

* Internal test changes (smoke tests, test refactoring)
* Implementation details (error propagation, internal structs)
* Dev toolchain changes (Makefile cleanup, CI tweaks)
* Pure documentation adjustments

**Wording guidelines**:
- Don't use "first-class", "recommended" for non-default options
- Be factual: "Added X" / "Fixed Y" / "Renamed A to B"
- Include CLI example when introducing a new feature
- Use em-dash (`—`) to separate feature name from description
- Group related features under `####` sub-headings when there are 2+ distinct areas

* Don't use "first-class", "recommended" for non-default options
* Be factual: "Added X" / "Fixed Y" / "Renamed A to B"
* Include CLI example when introducing a new feature
* Use em-dash (`—`) to separate feature name from description
* Group related features under `####` sub-headings when there are 2+ distinct areas

### Step 6: Update CHANGELOG.md

Read existing `CHANGELOG.md` and insert new entry at the top, after the header. Match the style of the most recent entries exactly.

Structural conventions (based on actual entries):
```markdown

````markdown
## [X.Y.Z] - YYYY-MM-DD

### New Features
Expand Down Expand Up @@ -113,31 +117,33 @@ Structural conventions (based on actual entries):
### Breaking Changes

- Renamed `old-name` to `new-name`
```
````

Key style points:
- Version numbers use `[X.Y.Z]` without `v` prefix in the heading
- Feature bullets use `**bold name** — em-dash description` format
- Code blocks use `bash` language tag for CLI examples
- Bug fixes describe the symptom, not the implementation
- Only include sections that have content (skip empty Performance, Breaking Changes, etc.)

* Version numbers use `[X.Y.Z]` without `v` prefix in the heading
* Feature bullets use `**bold name** — em-dash description` format
* Code blocks use `bash` language tag for CLI examples
* Bug fixes describe the symptom, not the implementation
* Only include sections that have content (skip empty Performance, Breaking Changes, etc.)

### Step 7: Sync Website Changelog

The website has its own changelog page at `website/src/pages/changelog.md`. After updating `CHANGELOG.md`, sync the new entry to the website version.

**Differences between the two files**:
- Website file has MDX frontmatter (`title`, `description`) and an intro paragraph — preserve these, don't overwrite
- Website file has a `---` separator after the intro, before the first version entry
- The release entries themselves are identical in content

* Website file has MDX frontmatter (`title`, `description`) and an intro paragraph — preserve these, don't overwrite
* Website file has a `---` separator after the intro, before the first version entry
* The release entries themselves are identical in content

**How to sync**: Read the website changelog, then insert the same new entry after the `---` separator (line after intro paragraph), before the first existing version entry. Do NOT replace the entire file — only insert the new entry block.

## Rules

- **User perspective** — write for users, not developers
- **No fabricated links** — never invent URLs or references
- **Verify features exist** — grep source before claiming a feature was added
- **No internal noise** — exclude test-only, CI-only, or refactor-only changes
- **Conventional format** — follow existing CHANGELOG.md style exactly
- **Always sync both** — `CHANGELOG.md` and `website/src/pages/changelog.md` must have identical release entries
* **User perspective** — write for users, not developers
* **No fabricated links** — never invent URLs or references
* **Verify features exist** — grep source before claiming a feature was added
* **No internal noise** — exclude test-only, CI-only, or refactor-only changes
* **Conventional format** — follow existing CHANGELOG.md style exactly
* **Always sync both** — `CHANGELOG.md` and `website/src/pages/changelog.md` must have identical release entries
Loading
Loading