Conversation
There was a problem hiding this comment.
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.
scripts/config/vale/styles/config/vocabularies/words/accept.txt
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: davidhamill1-nhs <109090521+davidhamill1-nhs@users.noreply.github.com>
…t uses of possessive apostrophes
|
|
|
Deployment Complete
|
There was a problem hiding this comment.
Should this file use other tests in the codebase for patterns/style?
There was a problem hiding this comment.
Is there benefit in describing approach to mocking?
There was a problem hiding this comment.
Is it helpful to direct this to the linting configs (commit hooks generally) and tell it to follow those rules? It may stop it writing things that will fail commit hooks later.
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
Checklist
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.