Chore: [AEA-0000] - workflow to sync copilot instructions#62
Chore: [AEA-0000] - workflow to sync copilot instructions#62anthony-nhs wants to merge 15 commits intomainfrom
Conversation
|
This PR is linked to a ticket in an NHS Digital JIRA Project. Here's a handy link to the ticket: AEA-0000 |
|
| @@ -0,0 +1,109 @@ | |||
| # Copilot instructions for CloudFormation YAML in this repo | |||
| --- | |||
| description: 'Brief description of the instruction purpose and scope' | |||
There was a problem hiding this comment.
suggestion: probably should say something like: Guidelines for writing, reviewing, and maintaining AWS resource orchestration with cloudformation
| # Java Copilot Instructions for NHS FHIR Validator Lambda | ||
|
|
||
| --- | ||
| description: 'Brief description of the instruction purpose and scope' |
There was a problem hiding this comment.
suggestion: again should probably say something more comprehensive here
| # Copilot Instructions for Kotlin Files | ||
|
|
||
| --- | ||
| description: 'Brief description of the instruction purpose and scope' |
| ## General Instructions | ||
|
|
||
| - High-level guideline 1 | ||
| - High-level guideline 2 | ||
|
|
||
| ## Best Practices | ||
|
|
||
| - Specific practice 1 | ||
| - Specific practice 2 | ||
|
|
||
| ## Code Standards | ||
|
|
||
| ### Naming Conventions | ||
| - Rule 1 | ||
| - Rule 2 | ||
|
|
There was a problem hiding this comment.
these can prolly get removed due to the language specific instructions
| ### File Organization | ||
| - Structure 1 | ||
| - Structure 2 |
There was a problem hiding this comment.
potentially this too, i feel like we got a general file organisation structure for higher level projects but individual packages i reckon still somewhat fluctuate, so those would probably need to go in the language specific instructions
| ### Pattern 1 | ||
| Description and example | ||
|
|
||
| \`\`\`language | ||
| code example | ||
| \`\`\` | ||
|
|
||
| ### Pattern 2 | ||
| Description and example | ||
|
|
||
| ## Validation | ||
|
|
||
| - Build command: `command to verify` | ||
| - Linting: `command to lint` | ||
| - Testing: `command to test` | ||
| ``` | ||
|
|
| ### 3. Examples and Code Snippets | ||
|
|
||
| Provide concrete examples with clear labels: | ||
|
|
||
| ```markdown | ||
| ### Good Example | ||
| \`\`\`language | ||
| // Recommended approach | ||
| code example here | ||
| \`\`\` | ||
|
|
||
| ### Bad Example | ||
| \`\`\`language | ||
| // Avoid this pattern | ||
| code example here | ||
| \`\`\` | ||
| ``` |
2 participants
Summary
Details