Skip to content

Add PR template with requirements checklist#36

Open
Copilot wants to merge 2 commits into
mainfrom
copilot/add-instructions-to-agent-config
Open

Add PR template with requirements checklist#36
Copilot wants to merge 2 commits into
mainfrom
copilot/add-instructions-to-agent-config

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 11, 2026

Summary

Adds .github/pull_request_template.md so every PR is pre-filled with checkboxes covering the requirements defined in copilot-instructions.md/AGENTS.md — preventing agents and humans alike from silently skipping them (screenshots, accessibility, security, British English).

Screenshots are now required for every PR. Non-visual changes (e.g. docs, config) must explicitly tick the checkbox and write "N/A – no visual change" in the placeholder, ensuring the requirement is never silently skipped.

Checklist

Language

  • All text, comments, and documentation are written in British English

Security

  • Client-side JavaScript has been reviewed against the OWASP Top 10
  • No XSS, injection, insecure eval, unsafe DOM manipulation, or exposed secrets introduced

Accessibility (WCAG 2.2 AA)

  • Semantic HTML elements used (<nav>, <main>, <article>, etc.) with ARIA roles where needed
  • Keyboard navigability verified
  • Sufficient colour contrast checked
  • Meaningful alt text added to all images

Screenshots

  • Desktop viewport screenshot (or N/A justification) included below
  • Mobile viewport screenshot (or N/A justification) included below

Desktop

N/A – no visual change

Mobile

N/A – no visual change

@landro landro requested a review from Copilot May 11, 2026 06:53
@landro landro marked this pull request as ready for review May 11, 2026 06:54
Copy link
Copy Markdown

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 a GitHub pull request template to standardise PR descriptions and ensure contributors explicitly confirm key project requirements (British English, security review, accessibility checks, screenshots).

Changes:

  • Introduces .github/pull_request_template.md with a structured summary section.
  • Adds a requirements checklist covering language, security (OWASP Top 10), accessibility (WCAG 2.2 AA), and screenshots.

Comment thread .github/pull_request_template.md Outdated
Comment on lines +21 to +23
<!-- Required for any visual change. Do NOT commit screenshots to the repository. -->
- [ ] Desktop viewport screenshot included below
- [ ] Mobile viewport screenshot included below
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@copilot add a non visual change to requirements files to align

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done in 9679224. The conditional wording is removed — screenshots are now required for every PR. Non-visual changes (docs, config, etc.) must tick the checkbox and write "N/A – no visual change" in the placeholder rather than silently omitting the section.

Copilot finished work on behalf of landro May 11, 2026 06:59
Copilot AI requested a review from landro May 11, 2026 06:59
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