You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ When suggesting changes:
19
19
- Optimise for reviewability
20
20
- Keep diffs focused and minimal
21
21
- If a change is non-obvious, add a short comment explaining intent.
22
-
- Comments should explain **why**, not restate **what*- the code does
22
+
- Comments should explain **why**, not restate **what** the code does
23
23
- Use a neutral, professional tone
24
24
- Avoid humour, sarcasm, or emojis in code comments
25
25
- Include all review comments in the first review, do not add additional review comments to code that hasn't changed since the previous commit.
@@ -47,11 +47,10 @@ When suggesting changes:
47
47
- Generally prefer API tokens or OAuth where possible, flag usage of username/password unless the API offers no alternative.
48
48
- Check that only strictly required fields are marked as `required: true`. Advanced options should never block first-time success.
49
49
- For each field in the array:
50
-
- displayName - First word uppercase, then lowercase (e.g. “Table name", or "API key"). Single value: singular. Multiple values: “(s)" (e.g. Tables name(s))
50
+
- displayName - First word uppercase, then lowercase (e.g. “Table name", or "API key"). Single value: singular. Multiple values: “(s)" (e.g. Tables name(s)). Do not use “you" “Your" in display names. Keep text neutral, concise, and descriptive.
51
51
- name - Should typically be the camel-cased version of the displayName.
52
-
- help - Do not use tooltips unless they add specific value. Never state the obvious (e.g. “Enter the API key here"). Start with a verb where possible (e.g. “Supports the ServiceNow filtering definition format"). Encourage include a reference link if relevant `Create an API key in the [Phare portal](https://docs.phare.io/api-reference/introduction)`
52
+
- help - Do not use tooltips unless they add specific value. Never state the obvious (e.g. “Enter the API key here"). Start with a verb where possible (e.g. “Supports the ServiceNow filtering definition format"). Encourage the author to include a reference link if relevant `Create an API key in the [Phare portal](https://docs.phare.io/api-reference/introduction)`
53
53
- placeholder - Mandatory for text fields. Use example placeholders (especially for URLs or values that follow a fixed pattern, e.g. rootly_xxxxxxxxx or https://organisation.atlassian.net) or “Enter the [data source][info needed in lowercase]". Use default values instead of hint text where a value is commonly the same across environments (e.g. default ports).
54
-
- displayName - Do not use “you" “Your" in display names. Keep text neutral, concise, and descriptive.
55
54
- title - Should not specify the `title` attribute on any fields.
- description - Typically one sentence only. No full stop at the end. Add relevant clarifications in brackets. Never use two sentences.
67
66
- tags - Mandatory. Reuse an existing category from other plugins where possible.
68
67
- ui
69
-
- displayName- First word uppercase, then lowercase (e.g. “Table name"). Single value: singular. Multiple values: “(s)" (e.g. Tables name(s). Do not use "you" "Your" in display names.
68
+
- displayName- First word uppercase, then lowercase (e.g. “Table name"). Single value: singular. Multiple values: “(s)" (e.g. Tables name(s). Do not use "you" "Your" in display names. Keep text neutral, concise, and descriptive.
70
69
- help - Use extremely sparingly. Never state the obvious. Only use when something important must be understood. Start with a verb where possible (e.g. “Supports the ServiceNow filtering definition format").
0 commit comments