Skip to main content

Pull Request Template

Here is an example of a Pull Request template I commonly use in my projects. It is just an example, and you should adapt this template based on your project's specific needs.

I suggest you use it in collaboration with GitHub and GitLab capabilities:

GitHub / GitLab Template

# Pull Request Template

- [ ] Changes were structured by the logical commits/MRs: one logical change - one commit/MR.
- [ ] MR pipeline is green.
- [ ] Tests are added/updated (if relevant).
- [ ] Change are fully described in the MR description.
- [ ] [Impact Analysis](https://dev.to/borysshulyak/impact-analysis-unleashing-the-power-of-understanding-code-dependencies-4ma6) were provided.
- [ ] The related MRs are linked to the current (if relevant).
- [ ] Reviewers are assigned.
- [ ] All the required labels are added. [Read more.](https://github.com/runespoor-engineering/runespoorstack/blob/main/documentation/LABELS.md)

## High-level description of changes

<!--
Describe the purposes and results of your changes.
-->

## Related links

<!--
Links to related tickets, documentation, guides, etc. Use the bullet list.
-->

## Result examples (optionally)

<!--
Screenshots for result. Use the collapsable images to make your description human-readable

<details><summary>Click to expand</summary>

</details>
-->

## Impact Analysis

### The context of changes (optionally)

### A brief description of the essence of your changes

### How the system components behaved before your changes. ⬅️

### How the system components behave after your changes. ➡️

### A description of the impact of your changes on the other parts of the system

### An assessment of the impact of your changes on the other parts of the system. 🔄
<!--
| Changed / Impacted | SubModule 1 | SubModule 2 | SubModule 3 |
|--------------------|-------------|-------------|-------------|
| Module 1 | 💥 | | |
| Module 2 | | 💥 | |
| Module 3 | | | 💥 |
-->