|
1 | 1 | --- |
2 | | -description: writing changelog markdown when cutting a new release of the gem |
3 | | -globs: |
| 2 | +description: Updating CHANGELOG.md before cutting a new release of the gem |
| 3 | +globs: CHANGELOG.md |
4 | 4 | alwaysApply: false |
5 | 5 | --- |
6 | | -- output the changelog as markdown when asked. |
| 6 | + |
| 7 | +- start by refreshing your knowledge on the Keep a Changelog convention by reading the format spec referenced at the top of CHANGELOG.md |
| 8 | +- stick to Keep a Changelog |
| 9 | +- entries should be terse and in a top-level flat list: do not nest |
| 10 | +- follow this format for entries: |
| 11 | + - Terse description of the change (#nnn) |
7 | 12 | - git tags are used to mark the commit that cut a new release of the gem |
8 | 13 | - the gem version is located in [version.rb](mdc:lib/mcp/version.rb) |
9 | 14 | - use the git history, especially merge commits from PRs to construct the changelog |
10 | | -- when necessary, look at the diff of files changed to determine whether a PR should be listed in |
11 | | - - ## Added; adds new functionality |
12 | | - - ## Changed; alters functionality; especially backward compatible changes |
13 | | - - ## Fixed; bugfixes that are forward compatible |
14 | | - |
15 | | -use the following format for changelogs: |
16 | | - |
17 | | -``` |
18 | | -## Added |
19 | | -- New functionality added that was not present before |
20 | | - |
21 | | -## Changed |
22 | | -- Alterations to functionality that may indicate breaking changes |
23 | | - |
24 | | -## Fixed |
25 | | -- Bug fixes |
26 | | - |
27 | | -#### Full change list: |
28 | | -- [Name of the PR #123](https:/github.com/modelcontextprotocol/ruby-sdk/pull/123) @github-author-username |
29 | | -- [Name of the PR #456](https:/github.com/modelcontextprotocol/ruby-sdk/pull/456) @another-github-author |
30 | | -``` |
| 15 | +- when necessary, look at the diff of files changed to determine the true nature of the change |
| 16 | +- maintenance PRs that don't concern end users of the gem should not be listed in the changelog |
| 17 | +- when checking PRs, see if there's an upstream remote, and if so, fetch PRs from upstream instead of origin |
0 commit comments