Update changelog skill with skip rules and allowed types
This commit is contained in:
@@ -7,23 +7,30 @@ Create changelog files for the important commits in this PR. The PR number is pr
|
|||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
1. First, check what commits are on the current branch compared to main:
|
1. Skip changelog for: documentation-only, internal refactoring, test-only, CI changes.
|
||||||
|
|
||||||
|
2. First, check what commits are on the current branch compared to main:
|
||||||
```
|
```
|
||||||
git log main..HEAD --oneline
|
git log main..HEAD --oneline
|
||||||
```
|
```
|
||||||
|
|
||||||
2. For each significant change, create a changelog file in the `changelog/` folder using the format:
|
3. For each significant change, create a changelog file in the `changelog/` folder using the format:
|
||||||
|
Allowed types: `added`, `changed`, `deprecated`, `removed`, `fixed`, `security`, `performance`, `other`
|
||||||
- `{PR_NUMBER}.added.md` - for new features
|
- `{PR_NUMBER}.added.md` - for new features
|
||||||
- `{PR_NUMBER}.added.2.md`, `{PR_NUMBER}.added.3.md` - for additional new features
|
- `{PR_NUMBER}.added.2.md`, `{PR_NUMBER}.added.3.md` - for additional entries of the same type
|
||||||
- `{PR_NUMBER}.changed.md` - for changes to existing functionality
|
- `{PR_NUMBER}.changed.md` - for changes to existing functionality
|
||||||
- `{PR_NUMBER}.fixed.md` - for bug fixes
|
- `{PR_NUMBER}.fixed.md` - for bug fixes
|
||||||
- `{PR_NUMBER}.deprecated.md` - for deprecations
|
- `{PR_NUMBER}.deprecated.md` - for deprecations
|
||||||
|
- `{PR_NUMBER}.removed.md` - for removed features
|
||||||
|
- `{PR_NUMBER}.security.md` - for security fixes
|
||||||
|
- `{PR_NUMBER}.performance.md` - for performance improvements
|
||||||
|
- `{PR_NUMBER}.other.md` - for other changes
|
||||||
|
|
||||||
3. Each changelog file should at least contain a main single line starting with `- ` followed by a clear description of the change.
|
4. Each changelog file should at least contain a main single line starting with `- ` followed by a clear description of the change.
|
||||||
|
|
||||||
4. If the change is complicated, changelog files can have indented lines after the main line with additional details or code samples.
|
5. If the change is complicated, changelog files can have indented lines after the main line with additional details or code samples.
|
||||||
|
|
||||||
5. Use ⚠️ emoji prefix for breaking changes.
|
6. Use ⚠️ emoji prefix for breaking changes.
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user