Clarify instruction file path in README usage documentation#559
Merged
Conversation
Updated the instructionsUsage template in constants.mjs to clarify that task-specific instruction files should be created in the .github/instructions/ folder with the pattern *.instructions.md (e.g., .github/instructions/my-csharp-rules.instructions.md), instead of the confusing original wording that mentioned both .github/.instructions.md files and .github/instructions folder. Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix confusing instructions in README file
Clarify instruction file path in README usage documentation
Jan 11, 2026
aaronpowell
approved these changes
Jan 11, 2026
aaronpowell
marked this pull request as ready for review
January 12, 2026 00:19
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies the ambiguous wording in the README usage instructions for instruction files, resolving confusion about where instruction files should be placed and how they should be named.
Changes:
- Updated the
instructionsUsagetemplate ineng/constants.mjsto clarify that instruction files follow the*.instructions.mdpattern and should be placed in the.github/instructions/directory - Added a concrete example path (
.github/instructions/my-csharp-rules.instructions.md) to illustrate the correct usage - Regenerated
docs/README.instructions.mdto reflect the updated template
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| eng/constants.mjs | Updated the instructionsUsage template string to replace ambiguous .github/.instructions.md with clearer *.instructions.md pattern and added example path |
| docs/README.instructions.md | Regenerated documentation reflecting the clarified instruction file path pattern with example |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.Description
The usage instructions had ambiguous wording that conflated file naming pattern with directory path:
Before:
After:
Changes
instructionsUsagetemplate ineng/constants.mjsto clarify file path pattern with concrete exampledocs/README.instructions.mdviaeng/update-readme.mjsType of Contribution
Additional Notes
Per @aaronpowell's clarification: instruction files follow the pattern
<name>.instructions.mdand live in.github/instructions/directory.By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.