new instruction use-cliche-data-in-docs.instructions#1203
Merged
aaronpowell merged 2 commits intogithub:stagedfrom Mar 29, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Copilot instruction aimed at preventing documentation from leaking real/sensitive data by requiring generic placeholder (“cliche”) example values.
Changes:
- Introduces
use-cliche-data-in-docs.instructions.mdwith rules and examples for substituting real data with safe placeholders in docs. - Registers the new instruction in
docs/README.instructions.mdfor discovery and installation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| instructions/use-cliche-data-in-docs.instructions.md | New instruction defining a strict boundary between implementation data and documentation examples, with approved placeholder patterns. |
| docs/README.instructions.md | Adds the instruction to the documented catalog with install links and a short description. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
aaronpowell
approved these changes
Mar 29, 2026
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.stagedbranch for this pull request.Description
Tested an initial version of the instructions on a repo I pretty much vibe-coded using real data in order to live test and make sure features worked correctly. The repo is extractEmail. I made the instructions because Copilot kept putting examples from the prompt into the documentation. Some of which were not good for documentation. Others examples had sensitive information. Even after ending with something like "And DO NOT put this example data in the documentation".
So, I made an initial draft. It worked good. Polished everything, and now I'm here.
The test for the updated instruction was to create a tool using real example data, and make sure the documentation did not include it. In short - it worked. For the full test results
ctrl + clicksupport-repo.Prompt
Results
Good. A fun little command-line tool that does versal lettering, and used cliche data for documentation, and not data from prompt.
Type of Contribution
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.