Add copilot instructions file to improve AI assistance #1486
Conversation
* Make copilot assisted commits add a changelog entry * Enable developers to ask copilot to update the changelog for them
Palaso Tests 4 files ±0 4 suites ±0 10m 47s ⏱️ -2s Results for commit 9c35eee. ± Comparison against base commit d010103. This pull request skips 1 test.♻️ This comment has been updated with latest results. |
tombogle
left a comment
tombogle
left a comment
There was a problem hiding this comment.
@tombogle reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @jasonleenaylor)
.github/copilot-instructions.md line 18 at r1 (raw file):
- **Update the Changelog:** If the suggested code changes functionality, fixes a bug, or adds a feature, you **must** generate an update for `CHANGELOG.md`. - Look for the `## [Unreleased]` section at the top of the changelog. - Insert a bullet point under the appropriate subsection: `### Added`, `### Changed`, or `### Fixed`.
What about the less-common:
Deprecated
Removed
Security
? Maybe we don't anticipate Copilot doing those kinds of things?
imnasnainaec
left a comment
imnasnainaec
left a comment
There was a problem hiding this comment.
@imnasnainaec reviewed all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @jasonleenaylor)
.github/copilot-instructions.md line 19 at r1 (raw file):
- Look for the `## [Unreleased]` section at the top of the changelog. - Insert a bullet point under the appropriate subsection: `### Added`, `### Changed`, or `### Fixed`. - If the subsections do not exist under `[Unreleased]`, create them.
New subsections should be created according to the order given in the CHANGELOG comment
<!-- Available types of changes:
### Added
### Fixed
### Changed
### Deprecated
### Removed
### Security
-->
|
@jasonleenaylor we should do a brand-agnostic AGENTS.md instead, along with |
jasonleenaylor
left a comment
jasonleenaylor
left a comment
There was a problem hiding this comment.
Done
Reviewable status: 0 of 2 files reviewed, all discussions resolved (waiting on @imnasnainaec and @tombogle)
| - `### Security` - for security-related fixes or improvements | ||
| - If the subsections do not exist under `[Unreleased]`, create them as needed. | ||
| - Format: `- **[Scope]** Description of the change.` (where Scope is the affected library/namespace) | ||
| - For breaking changes, prefix with `BREAKING CHANGE:` in the description. |
There was a problem hiding this comment.
This should be enhanced so that it also adds +semver:major to the commit message for breaking changes and +semver:minor for added functionality.
This change is