-
Notifications
You must be signed in to change notification settings - Fork 498
Add copilot instructions #3470
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
Open
nkolev92
wants to merge
1
commit into
main
Choose a base branch
from
dev-nkolev92-addCopilotInstructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add copilot instructions #3470
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,56 @@ | ||
# .NET Documentation Guidelines | ||
|
||
## Disclosure | ||
|
||
For any Markdown files generated by AI, always disclose that they were created with the assistance of AI. Add the following frontmatter key/value pair: | ||
|
||
```markdown | ||
ai-usage: ai-generated | ||
``` | ||
|
||
## Terminology | ||
|
||
Unless otherwise specified, all .NET content refers to modern .NET (not .NET Framework). | ||
|
||
## Writing Style | ||
|
||
Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) with these specifics: | ||
|
||
### Voice and Tone | ||
|
||
- Active voice, second person addressing reader directly. | ||
- Conversational tone with contractions. | ||
- Present tense for instructions/descriptions. | ||
- Imperative mood for instructions ("Call the method" not "You should call the method"). | ||
- Use "might" instead of "may" for possibility. | ||
- Use "can" instead of "may" for permissible actions. | ||
- Avoid "we"/"our" referring to documentation authors or product teams. | ||
|
||
### Structure and Format | ||
|
||
- Sentence case headings (no gerunds in titles). | ||
- Be concise, break up long sentences. | ||
- Oxford comma in lists. | ||
- Use bullets for unordered lists. | ||
- Number all ordered list items as "1." (not sequential numbering like "1.", "2.", "3.", etc.) | ||
- Ordered and unordered lists should use complete sentences with proper punctuation, ending with a period if it's more than three words. | ||
- Avoid "etc." or "and so on" - provide complete lists or use "for example". | ||
- Use "for example" instead of "e.g.". | ||
- Use "that is" instead of "i.e.". | ||
- No consecutive headings without content between them. | ||
|
||
### Formatting Conventions | ||
|
||
- **Bold** for UI elements. | ||
- `Code style` for file names, folders, custom types, non-localizable text. | ||
- Raw URLs in angle brackets. | ||
- Use relative links for files in this repo. | ||
- Remove `https://learn.microsoft.com/en-us` from learn.microsoft.com links. | ||
|
||
## File Naming | ||
|
||
New Markdown files: lowercase with hyphens, omit filler words (the, a, etc.). | ||
|
||
## Special Cases | ||
|
||
- When you (Copilot) are assigned an issue in GitHub, after you've completed your work and the workflows (status checks) have run, check to make sure there are no build warnings under the OpenPublishing.Build status check. If there are, open the build report (under View Details) and resolve any build warnings you introduced. | ||
nkolev92 marked this conversation as resolved.
Show resolved
Hide resolved
|
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.