generated from dynatrace-oss/template-project
-
Notifications
You must be signed in to change notification settings - Fork 39
chore: Add Copilot instructions and prompts for changelog and release flow #117
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
christian-kreuzberger-dtx
merged 1 commit into
dynatrace-oss:main
from
MrManny:116-copilot-supported-release-helpers
Aug 26, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
applyTo: 'CHANGELOG.md' | ||
--- | ||
|
||
Do not edit the file unless explicitly requested by the user. | ||
When releasing a new version, you will be asked to create a new section in the `CHANGELOG.md` file for the version based on "Unreleased Changes". | ||
|
||
# Style guidelines | ||
|
||
- Use semantic versioning headings (e.g., ## <version>) | ||
- Release candidates are supported with version suffix format (e.g., `0.5.0-rc.1` should be labeled as "0.5.0 (Release Candidate 1)" in the changelog) | ||
- Do not use subheadings | ||
- Do not mention commit hashes | ||
- Write in past tense (e.g., "improved", "introduced", "added") | ||
- Balance technical accuracy with user-facing language | ||
- Use bullet points for individual changes | ||
|
||
# Content guidelines | ||
|
||
- Entries should be concise but can include technical details relevant to users | ||
- Write a bullet point for every new, changed, fixed, or removed feature | ||
- Do not use emojis | ||
- Include both user benefits and technical specifics when relevant | ||
|
||
# Writing patterns | ||
|
||
## Change descriptions | ||
|
||
- **New tools/features**: "Added [tool/feature name] [brief description]" | ||
- **Improvements**: "Improved [component] to [specific enhancement]" | ||
- **Bug fixes**: "Fixed [issue description]" or "Fixed: [specific problem]" | ||
- **Removals**: "Removed [item] [reason if relevant]" | ||
- **Technical changes**: Include scope changes, API modifications, and architectural improvements | ||
|
||
## User-centric language | ||
|
||
- Emphasize user capabilities: "You can now...", "You will now find...", "It is now possible to..." | ||
- Explain business value: "enabling more precise...", "providing greater flexibility...", "ensuring smoother performance..." | ||
- Use positive framing: "enhanced", "improved", "better", "more accurate" | ||
|
||
## Technical details to include | ||
|
||
- Tool additions, modifications, and removals | ||
- Scope changes and OAuth permissions | ||
- API endpoint changes that affect users | ||
- Performance improvements with specific impacts | ||
- Breaking changes with migration guidance |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
mode: agent | ||
--- | ||
|
||
# Release Instructions | ||
|
||
When preparing a release, follow these steps to ensure everything is in order: | ||
|
||
1. Go to the main branch and pull the latest changes. If dependencies changed, run `npm ci`. | ||
2. Ask the user what the new version number should be. It should follow semantic versioning, but it may have a suffix for release candidates. | ||
3. Work on a release branch, typically named `chore/prepare-release-<version>`. | ||
4. Create a new section in CHANGELOG.md for the version below "Unreleased Changes". | ||
5. Move all entries from "Unreleased Changes" to this new section. Reword them in the process to fit the content guidelines specified in `.github/instructions/changelog.instructions.md`. | ||
6. Update the version number in `package.json`. | ||
7. Run `npm install --package-lock-only` to sync the lock file. | ||
8. Let the user verify the release notes and version number before proceeding. | ||
9. Commit the changes with a message like `chore(release): prepare for <version> release`. |
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.