Skip to content

[GPCAPIM-232] Add agent instructions#100

Open
davidhamill1-nhs wants to merge 7 commits intomainfrom
feature/GPCAPIM-232_agents_md
Open

[GPCAPIM-232] Add agent instructions#100
davidhamill1-nhs wants to merge 7 commits intomainfrom
feature/GPCAPIM-232_agents_md

Conversation

@davidhamill1-nhs
Copy link
Contributor

Description

Added some agent instructions and two starter-for-ten agents using the GitHub Copilot docs

Context

The use of coding agents has been enabled by NHSDigital org. These files will give us a starting point to use agents to help maintain and improve our repository.

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • [ x] I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming
  • Exceptions/Exclusions to coding standards (e.g. #noqa or #NOSONAR) are included within this Pull Request.

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • [x ] I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds initial GitHub Copilot repository instructions and two “starter” agent profiles to guide automated contributions, plus updates to the Vale accepted vocabulary to reduce documentation lint noise.

Changes:

  • Add repository-level Copilot instructions describing the project, workflows, and commit conventions.
  • Add two agent definitions (unit test writer and documentation writer) with project-specific boundaries.
  • Extend Vale “accept” vocabulary with additional technical terms.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.

File Description
scripts/config/vale/styles/config/vocabularies/words/accept.txt Adds accepted terms for Vale to reduce false-positive spelling/style flags.
.github/instructions/copilot-instructions.md Introduces repo-specific Copilot guidance (project context, commands, conventions).
.github/agents/unit_test.agent.md Defines a unit-test-writing agent and where it should read/write tests.
.github/agents/docs.agent.md Defines a documentation-writing agent focused on updating **/README.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

davidhamill1-nhs and others added 2 commits March 4, 2026 10:17
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: davidhamill1-nhs <109090521+davidhamill1-nhs@users.noreply.github.com>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 4, 2026

@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 4, 2026

@github-actions
Copy link

github-actions bot commented Mar 4, 2026

Deployment Complete

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants