Pull Request guidelines and template

Context and Problem Statement

The structure of a Pull Request (PR) can take many forms, making it difficult to understand at a glance the what, why and how of a PR. Which form should we choose?

Considered Options

• Formless – No conventions for PR format and structure
• What? Why? How? Testing? Screenshots (optional) Anything Else?
• GitHub pull request template examples
• How to Write a Proper Description for a Pull Request

Decision Outcome

Chosen option: “What? Why? How? Testing? Screenshots (optional) Anything Else?”, because clear, well-structured pull request descriptions help reviewers understand the context, changes, and testing done, making code reviews faster and more effective..

Although not a template format, we should also include GitHub’s communication guidelines in How to write the perfect pull request.

More Information

Whichever format is chosen, we should create an initialiser to add the GitHub PR template to a project.

---