Skip to content

Commit 7b1afeb

Browse files
authored
Docs: [AEA-0000] - fix docs (#7)
## Summary - Routine Change ### Details - fix docs
1 parent a7849a1 commit 7b1afeb

9 files changed

Lines changed: 19 additions & 3 deletions

.github/instructions/general/security.instructions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
applyTo: '**/*'
33
description: "Comprehensive secure coding instructions for all languages and frameworks, based on OWASP Top 10 and industry best practices."
44
---
5+
6+
This file is mastered in https://github.com/NHSDigital/eps-copilot-instructions and is automatically synced to all EPS repositories. To suggest changes, please open an issue or pull request in the eps-copilot-instructions repository.
7+
58
# Secure Coding and OWASP Guidelines
69

710
## Instructions

.github/instructions/languages/cdk.instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description: 'Guidelines for writing, reviewing, and maintaining AWS CDK (TypeSc
33
applyTo: 'packages/cdk/**/*.ts'
44
---
55

6+
This file is mastered in https://github.com/NHSDigital/eps-copilot-instructions and is automatically synced to all EPS repositories. To suggest changes, please open an issue or pull request in the eps-copilot-instructions repository.
7+
68
# AWS CDK TypeScript Development
79

810
This file provides instructions for generating, reviewing, and maintaining AWS CDK code in the `packages/cdk` folder. It covers best practices, code standards, architecture, and validation for infrastructure-as-code using AWS CDK in TypeScript.

.github/instructions/languages/cloudformation.instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description: 'Guidelines for writing, reviewing, and maintaining cloudformation
33
applyTo: 'cloudformation/**'
44
---
55

6+
This file is mastered in https://github.com/NHSDigital/eps-copilot-instructions and is automatically synced to all EPS repositories. To suggest changes, please open an issue or pull request in the eps-copilot-instructions repository.
7+
68
## General
79
- Prefer YAML (not JSON). Follow existing style in [cloudformation/account_resources.yml](cloudformation/account_resources.yml), [cloudformation/ci_resources.yml](cloudformation/ci_resources.yml), [cloudformation/artillery_resources.yml](cloudformation/artillery_resources.yml), [cloudformation/account_resources_bootstrap.yml](cloudformation/account_resources_bootstrap.yml), [cloudformation/management.yml](cloudformation/management.yml).
810
- Always start with `AWSTemplateFormatVersion: "2010-09-09"`.

.github/instructions/languages/python.instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description: 'Guidelines for writing high-quality, maintainable python code with
33
applyTo: '**/*.py'
44
---
55

6+
This file is mastered in https://github.com/NHSDigital/eps-copilot-instructions and is automatically synced to all EPS repositories. To suggest changes, please open an issue or pull request in the eps-copilot-instructions repository.
7+
68
# Python Copilot Instructions
79

810
These instructions are designed to guide GitHub Copilot in generating effective, maintainable, and domain-appropriate Python code. They are intended to be generic and applicable to a wide range of Python projects.

.github/instructions/languages/sam.instructions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
description: 'Guidelines for writing, reviewing, and maintaining SAM templates'
33
applyTo: 'SAMtemplates/**'
44
---
5+
6+
This file is mastered in https://github.com/NHSDigital/eps-copilot-instructions and is automatically synced to all EPS repositories. To suggest changes, please open an issue or pull request in the eps-copilot-instructions repository.
7+
58
## Scope
69
These instructions apply exclusively to files located under the `SAMtemplates` directory. Ensure that any SAM templates or related configurations outside this directory are not governed by these guidelines.
710

.github/instructions/languages/terraform.instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description: 'Comprehensive guidelines for writing, organizing, and maintaining
33
applyTo: 'terraform/**/*.tf'
44
---
55

6+
This file is mastered in https://github.com/NHSDigital/eps-copilot-instructions and is automatically synced to all EPS repositories. To suggest changes, please open an issue or pull request in the eps-copilot-instructions repository.
7+
68
# Terraform Development Guidelines
79

810
This document provides best practices and conventions for writing, organizing, and maintaining Terraform code. It is intended for use by developers and GitHub Copilot to ensure consistency, reliability, and maintainability across all Terraform files in the project.

.github/instructions/languages/typescript.instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description: 'Guidelines for writing high-quality, maintainable TypeScript code
33
applyTo: '**/*.{ts,tsx}'
44
---
55

6+
This file is mastered in https://github.com/NHSDigital/eps-copilot-instructions and is automatically synced to all EPS repositories. To suggest changes, please open an issue or pull request in the eps-copilot-instructions repository.
7+
68
# TypeScript Development Guidelines
79

810
This document provides instructions for generating, reviewing, and maintaining TypeScript code. It is designed to guide Copilot and developers in producing domain-specific, robust, and maintainable code across a variety of TypeScript projects.

.github/prompts/code_review.prompt.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
description: "Perform a comprehensive code review"
33
---
44

5+
This file is mastered in https://github.com/NHSDigital/eps-copilot-instructions and is automatically synced to all EPS repositories. To suggest changes, please open an issue or pull request in the eps-copilot-instructions repository.
6+
57
## Role
68

79
You're a senior software engineer conducting a thorough code review. Provide constructive, actionable feedback.

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ The action is intended to be called from another repository. It:
1818
3. Replaces the target repository's Copilot instruction files with the shared versions
1919
4. Creates a signed pull request containing the sync changes
2020

21-
The action currently syncs content from `NHSDigital/eps-common-workflows`.
22-
2321
## Files synced by the action
2422

2523
The action copies the following paths into the calling repository:
@@ -52,7 +50,7 @@ on:
5250

5351
jobs:
5452
sync-copilot-instructions:
55-
runs-on: ubuntu-latest
53+
runs-on: ubuntu-22.04
5654
environment: create_pull_request
5755
permissions:
5856
contents: read

0 commit comments

Comments
 (0)