Skip to content

Commit 3b5e07d

Browse files
committed
Review comments
1 parent 3cbeba3 commit 3b5e07d

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ plugins/Spotify/* @jame2O
1717
plugins/Steam/* @kmichalski0
1818
plugins/SumoLogic/* @richpeters
1919
plugins/TransportForLondon/* @clarkd
20+
plugins/UniFi/* @adamkinniburgh
2021

2122

2223
# Fallback – if a plugin has no specified author

.github/copilot-instructions.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ When suggesting changes:
1919
- Optimise for reviewability
2020
- Keep diffs focused and minimal
2121
- 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
2323
- Use a neutral, professional tone
2424
- Avoid humour, sarcasm, or emojis in code comments
2525
- 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:
4747
- Generally prefer API tokens or OAuth where possible, flag usage of username/password unless the API offers no alternative.
4848
- Check that only strictly required fields are marked as `required: true`. Advanced options should never block first-time success.
4949
- 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.
5151
- 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)`
5353
- 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.
5554
- title - Should not specify the `title` attribute on any fields.
5655

5756
### Out-of-the-box dashboards (defaultContent/**/*.dash.json)
@@ -66,7 +65,7 @@ When suggesting changes:
6665
- description - Typically one sentence only. No full stop at the end. Add relevant clarifications in brackets. Never use two sentences.
6766
- tags - Mandatory. Reuse an existing category from other plugins where possible.
6867
- 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.
7069
- 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").
7170

7271
### Documentation - (docs/README.md)

0 commit comments

Comments
 (0)