Skip to content

Commit 34a33b1

Browse files
Add Agent instructions to use semver in appropriate commits
1 parent b51a326 commit 34a33b1

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,16 @@ You are an expert C# developer assisting with the `sillsdev/libpalaso` repositor
2525
- If the subsections do not exist under `[Unreleased]`, create them as needed.
2626
- Format: `- **[Scope]** Description of the change.` (where Scope is the affected library/namespace)
2727
- For breaking changes, prefix with `BREAKING CHANGE:` in the description.
28+
29+
- **Commit Message Format:** Follow semantic versioning guidelines in commit messages:
30+
- Include semantic version tags to indicate the impact of changes:
31+
- `+semver:major` - for breaking changes that require a major version bump
32+
- `+semver:minor` - for new features, added functionality, or deprecations that require a minor version bump
33+
- If the change doesn't require a major or minor version bump (i.e., it's a patch-level change), the `+semver` tag is omitted
34+
- Format: `Brief description of change +semver:level` (or just the description for patch-level changes)
35+
- Examples:
36+
- `Add new IWritingSystemRepository interface +semver:minor`
37+
- `BREAKING CHANGE: Remove deprecated FileLocator methods +semver:major`
38+
- `Fix null reference exception in BetterLabel` (no tag needed for patch)
39+
- `Refactor internal caching mechanism` (no tag needed for patch)
40+
- **Note:** BREAKING CHANGE can appear in any changelog category but always requires `+semver:major`

0 commit comments

Comments
 (0)