Skip to content

Commit 421696a

Browse files
Update copilot-instructions (#1998)
* Update copilot-instructions.md * Update copilot-instructions.md
1 parent 08abbc0 commit 421696a

File tree

1 file changed

+27
-44
lines changed

1 file changed

+27
-44
lines changed

.github/instructions/copilot-instructions.md

Lines changed: 27 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,10 @@ use the full name on first use and short name after, for example:
5151
- Grafana Beyla (full), Beyla (short)
5252

5353
Refer to the "OpenTelemetry Collector" as "Collector" after the first use.
54-
Still use "OpenTelemetry Collector" when refering to a distribution,
54+
Still use "OpenTelemetry Collector" when referring to a distribution,
5555
and for headings and links.
5656

5757
Always use the full name for "Grafana Cloud".
58-
Always capitalize and use the full name for Application Observability.
5958

6059
Never use abbreviations for product names unless specifically asked to,
6160
for example:
@@ -84,13 +83,12 @@ Focus on Grafana and not the partner product, for example:
8483
- For an integration with Azure don't document Azure set up
8584
- For a migration from DataDog don't document DataDog set up or usage
8685

87-
## frontmatter
86+
## Front matter
8887

8988
Never remove front matter content at the start of the file.
90-
This includes all content from the start of the file,
91-
inbetween a pair of tripple dashes (---).
89+
This includes all content from the start of the file that's between a pair of triple dashes (`---`).
9290

93-
Never removed YAML front matter meta data unless specifically asked to.
91+
Never removed YAML front matter metadata unless specifically asked to.
9492

9593
For example, never remove or delete this or other front matter:
9694

@@ -104,19 +102,19 @@ cascade:
104102

105103
# OpenTelemetry
106104

107-
Markdown content...
105+
<MARKDOWN CONTENT>
108106
```
109107

110108
Only edit front matter copy if specifically asked to.
111109
When performing a copy edit task,
112110
ask the user if they'd like you to also edit the front matter copy.
113-
Still never remove front matter meta data properpties.
111+
Still never remove front matter metadata fields.
114112

115113
## Structure
116114

117115
Structure articles into sections with headings.
118116

119-
The frontmatter YAML `title` and the content h1 (#) heading should be the same.
117+
The front matter YAML `title` and the content h1 (#) heading should be the same.
120118
Never remove the content h1 heading, this redundancy is required.
121119

122120
Always include copy after a heading, for example:
@@ -143,11 +141,9 @@ Add a blank line after headings, for example:
143141
Copy after the heading and a blank line.
144142
```
145143

146-
The immediate copy after a heading should introduce and overview what is
147-
covered in the section.
144+
The immediate copy after a heading should introduce and overview what's covered in the section.
148145

149-
Start articles with an introduction that covers the goal of the article,
150-
example goals:
146+
Start articles with an introduction that covers the goal of the article, example goals:
151147

152148
- Learn concepts
153149
- Set up or install something
@@ -163,12 +159,12 @@ Follow the goal with a list of prerequisites, for example:
163159
```markdown
164160
Before you begin ensure you have the following:
165161

166-
- <Prerequisite 1>
167-
- <Prerequisite 2>
162+
- <PREREQUISITE 1>
163+
- <PREREQUISITE 2>
168164
- ...
169165
```
170166

171-
Suggest and link to next steps and related resources at the end of the article,
167+
If asked to do so, suggest and link to next steps and related resources at the end of the article,
172168
for example:
173169

174170
- Learn more about A, B, C
@@ -177,9 +173,9 @@ for example:
177173
- Use X to achieve Z
178174
- Project homepage or documentation
179175
- Project repository (for example, GitHub, GitLab)
180-
- Project package (for example, pip or npm)
176+
- Project package (for example, pip or NPM)
181177

182-
You don't need to use the "Refer to..." syntax for next steps,
178+
You don't need to use the "Refer to" syntax for next steps,
183179
use the list time text for the link text.
184180

185181
## Style
@@ -199,7 +195,7 @@ Always use contractions over multiple words, for example:
199195
- use "isn't" and not "is not"
200196
- use "that's" and not "that is"
201197
- use "you're" and not "you are"
202-
- use "Don't" and not "do not"
198+
- use "don't" and not "do not"
203199

204200
Don't use filler words or phrases, for example:
205201

@@ -210,8 +206,7 @@ Don't use filler words or phrases, for example:
210206
- "keep in mind"
211207

212208
In most cases, use verbs and nouns without adverbs or adjectives.
213-
You may use minimal adverbs and adjectives,
214-
when introucing or overviewing a Grafana Labs product.
209+
You may use minimal adverbs and adjectives when introducing a Grafana Labs product.
215210

216211
Don't use figures of speech.
217212

@@ -223,7 +218,7 @@ Never use cultural references or charged language.
223218

224219
Write in present simple tense.
225220

226-
Avoid present continous tense.
221+
Avoid present continuous tense.
227222

228223
Only write in future tense to show future actions.
229224

@@ -239,7 +234,7 @@ Address users as "you".
239234

240235
Don't use first person perspective.
241236

242-
## Wordlist
237+
## Word list
243238

244239
Use allowlist/blocklist instead of whitelist/blacklist.
245240

@@ -291,7 +286,7 @@ Avoid using words created for UI features when possible, for example
291286

292287
Write complete sentences for lists, for example:
293288

294-
- Works with all languages and frameworks (correct)
289+
- Works with all languages and frameworks. (correct)
295290
- all languages and frameworks (wrong)
296291

297292
Always use dashes for unordered lists, for example
@@ -310,10 +305,10 @@ Never use asterisks for unordered lists, for example:
310305
* List item 3 (wrong)
311306
```
312307

313-
Never use full stops at the end of unordered list items, for example:
308+
Use full stops at the end of list items if the item is a full sentence, otherwise, omit it.
314309

315310
```markdown
316-
- Works with all languages and frameworks (correct)
311+
- Works with all languages and frameworks. (correct)
317312
- Works with all languages and frameworks (wrong)
318313
```
319314

@@ -341,15 +336,6 @@ Always start the next list item immediately on the next line, for example:
341336
- List item 3
342337
```
343338

344-
Never use new lines between list items, for example:
345-
346-
```markdown
347-
- List item 1
348-
349-
- List item 2 (wrong)
350-
351-
- List item 3 (wrong)
352-
```
353339

354340
If a list starts with a keyword, bold the keyword and follow with a colon,
355341
for example:
@@ -373,10 +359,10 @@ For example:
373359

374360
## Code
375361

376-
Use single code backticks for:
362+
Use single code backticks \` for:
377363

378364
- user input
379-
- placeholders in markdown, for example _`<PLACEHOLDER_NAME>`_
365+
- placeholders in Markdown, for example _`<PLACEHOLDER_NAME>`_
380366
- files and directories, for example `/opt/file.md`
381367
- source code keywords and identifiers,
382368
for example variables, function and class names
@@ -410,7 +396,7 @@ OTEL_EXPORTER_OTLP_ENDPOINT=<OTLP_ENDPOINT>
410396
The placeholder includes the name and the less than and greater than symbols,
411397
for example <PLACEHOLDER_NAME>.
412398
413-
If the placeholder is markdown emphasize it with underscores,
399+
If the placeholder is Markdown emphasize it with underscores,
414400
for example _`<PLACEHOLDER_NAME>`_.
415401
416402
In code blocks use the placeholder without additional backticks or emphasis,
@@ -479,7 +465,7 @@ kubectl get pods --namespace default
479465
```
480466
````
481467
482-
The output will resemble the following:
468+
The output resembles the following:
483469
484470
```text
485471
NAME READY STATUS RESTARTS AGE
@@ -503,7 +489,7 @@ Use the following values for option:
503489
504490
- YAML/JSON, code, or parameter field if one exists for that configuration
505491
- Environment variable field if one exists for that configuration
506-
- If there is a YAML and Environment variable option separate them with `<br>`
492+
- Use semantic HTML inside table cells for multiple paragraphs or list items.
507493
508494
Use a short sentence for the summary.
509495
After the summary sentence and in the same cell,
@@ -524,7 +510,7 @@ An example configuration table:
524510
| `logging.level`<br>`LOG_LEVEL` | Sets the logging verbosity. Refer to [logging level](#logging-level) for details. | No | String | `debug`, `info`, `warn`, `error` | `info` |
525511
```
526512
527-
In some ocassions you can drop the Values column, for example,
513+
In some occasions you can drop the Values column, for example,
528514
when all the configuration have a Boolean type (yes/no) or (1/0).
529515
530516
After the table, for each configuration, add a sub-section.
@@ -615,9 +601,6 @@ Use admonitions sparingly.
615601
Only include exceptional information in admonitions,
616602
this means you will use it more often for warnings than notes and cautions.
617603
618-
When an admonition is used, place it after any initial written information to
619-
the user. Do not place admonitions right at the end of sections where they might be missed.
620-
621604
Never delete Hugo shortcodes unless specifically asked to,
622605
for example don't delete shortcodes:
623606

0 commit comments

Comments
 (0)