alphagov / govuk-frontend

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.
https://frontend.design-system.service.gov.uk/
MIT License
1.18k stars 322 forks source link

Add template for pull requests to encourage better PR structure #5329

Open romaricpascal opened 1 month ago

romaricpascal commented 1 month ago

What

Add a pull request template to the repository to guide people when raising a PR with hints about information that would be useful to provide (eg. screenshots, future works, questions that need answering), as well as reminders for code changes that might have been skipped (macro options, tests, CHANGELOG...)

Why

Consistent PR structure would help with review, especially if we nudge towards better description of what's in the PR. Reminders about tests, doc changes... would help ensure the PRs contain everything that's needed for them to be merged (and avoid extra PRs to add them).

Who needs to work on this

Developers, Tech writers

Who needs to review this

Developers, Tech writers

Done when

romaricpascal commented 1 month ago

Quickly browsing through recent PRs (especially those of @querkmachine which are always pretty thorough and well written), here's a base structure for discussion: