Skip to content

Commit 493637f

Browse files
committed
add project instructions
1 parent 12a9f00 commit 493637f

3 files changed

Lines changed: 24 additions & 1 deletion

File tree

.github/copilot-instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## Project-Specific instructions
2+
Check the following files for any project-specific coding standards or guidelines:
3+
- .github/instructions/project/instructions.md
4+
15
# Base Coding Standards
26
- Follow clean code principles
37
- Write comprehensive tests
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# EPS Common Workflow - copilot instructions
2+
3+
## Overview
4+
This contains common github workflows that are used by other EPS projects
5+
6+
## General
7+
These rules should be followed for all workflows
8+
9+
*NEVER* use a version number in 3rd party actions or workflows - always use the git commit sha instead
10+
*NEVER* use secrets: inherit in a workflow - always define what secrets are being passed through to another workflow
11+
*NEVER* use an input to a workflow directly in a code execution block. Always define an environment variable and use that in the code execution block
12+
13+
All use of 3rd party actions or workflows outside of NHSDigital github org should be carefully evaluated before deciding to use them. Notice should be taken of
14+
- How often is the action or workflow updated. Avoid any workflows that have not been updated in over a year
15+
- Can the action or workflow be easily written locally with a few simple shell or github actions commands
16+
17+
All workflows that are designed to be called from another repo should have a `workflow_call` trigger.
18+
Workflows designed to be called from other repos should be documented in the README.md file

.github/workflows/sync_copilot.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ jobs:
4141
path: eps-common-workflows
4242
repository: NHSDigital/eps-common-workflows
4343
sparse-checkout: |
44-
- .github/instructions
44+
- .github/instructions/general
45+
- .github/instructions/languages
4546
- .github/copilot-instructions.md
4647
- .github/prompts
4748

0 commit comments

Comments
 (0)