Merge pull request #7 from squaredup/work/dc/copilot

Author: clarkd

.github/PULL_REQUEST_TEMPLATE/Add a new plugin.md

@@ -1,19 +1,12 @@
 <!--
   Thanks for contributing a new community-authored SquaredUp plugin!
 -->
-
 ## 🔌 Plugin overview
 
 - **Plugin name**:
 - **Purpose / problem solved**:
 - **Primary audience** (e.g. platform teams, SREs, product teams):
-
----
-
-## 🧩 Plugin configuration
-
 - **Authentication method(s)** (e.g. OAuth, Username/Password, API Key):
-
 ---
 
 ## 🖼️ Plugin screenshots
@@ -33,10 +26,10 @@
 
 ---
 
-
 ## ⚠️ Known limitations
-
-Are there any known gaps, constraints, or follow-up ideas?
+<!--
+  Are there any known gaps, constraints, or follow-up ideas?
+-->
 
 ---
 

.github/copilot-instructions.md

@@ -0,0 +1,56 @@
+When reviewing code, focus on:
+
+## Naming & language
+* Do not use “you” “Your”. Avoid conversational or instructional phrasing. Keep text neutral, concise, and descriptive.
+
+## Security
+- Check for hardcoded secrets, API keys, or credentials
+
+## Formatting
+
+* Follow existing formatting in the repo
+* Use consistent naming
+* Do not introduce formatting tools or config files unless explicitly requested.
+
+## Suggesting changes
+
+When suggesting changes:
+
+* Assume they will be reviewed by humans
+* Optimise for reviewability
+* Keep diffs focused and minimal
+* If a change is non-obvious, add a short comment explaining intent.
+* Comments should explain **why**, not restate **what** the code does
+* Use a neutral, professional tone
+* Avoid humour, sarcasm, or emojis in code comments
+
+## File-specific guidelines
+
+### icon.png/svg
+* SVG is preferred
+* Should be a square icon
+* Less than 100KB in size
+
+### Metadata (metadata.json)
+* displayName - Use the correctly styled/cased official product name for display names, e.g. SharePoint NOT sharepoint
+* description - One short sentence describing what users can build or monitor. Avoid API or implementation language like Access HaloPSA APIs and query ticket data.
+
+### UI Configuration (ui.json)
+- Generally prefer API tokens or OAuth where possible, flag usage of username/password unless the API offers no alternative.
+- Check that only stricly required fields are marked as `required`. Advanced options should never block first-time success.
+- Tooltips - Do not use tooltips unless they add specific value. Never state the obvious (e.g. “Enter the API key here”).
+- Placeholder text - Mandatory for text fields. Use example placeholders (especially for URLs) 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).
+- Do not use “you” “Your”. Avoid conversational or instructional phrasing. Keep text neutral, concise, and descriptive.
+* Should not specify the `title` attribute on fields
+
+### Out-of-the-box dashboards (*.dash.json)
+* Dashboard names - Use title case
+* Tile names - Use title case
+
+### Data streams - dataStreams/*.json
+* Display name - Use noun-based names describing the returned data, e.g. Tickets. Avoid verbs such as Get, Fetch, Run, Execute
+* Description - One sentence only. No full stop at the end. Add relevant clarifications in brackets. Never use two sentences.
+* Category - Mandatory. Reuse an existing category from other plugins where possible (e.g. Query).
+* ui
+  * Field names - First word uppercase, then lowercase (e.g. “Table name”). Single value: singular. Multiple values: “(s)” (e.g. Tables name(s)
+  * Tooltips - 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”).

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+**Switch to the `Preview` tab above and select the appropriate PR template to use for this change:**
+
+- [Adding a new plugin](?template=Add%20a%20new%20plugin.md)
+- [Change to an existing plugin](?template=Change%20to%20an%20existing%20plugin.md)
+- [Miscellaneous change e.g. docs/metadata](?template=Miscellaneous%20change.md)