Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PR template #16

Merged
merged 2 commits into from
Aug 11, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Objective

- Describe the aim of this pull request.
- If this closes an issue, type "Closes #X".

## Solution

- Describe the steps taken to achieve the objective.

---

## Changelog

> This section is optional.
> If this PR only fixes a trivial bug
> or has no externally-visible impact in the API,
> then feel free to delete this section.

- This repository follows the [_Keep A Changeog_][KAC] format.
- Additionally, this follows [_Semantic Versioning_][SemVer].

[KAC]: https://keepachangelog.com/en/1.0.0/
[SemVer]: https://semver.org/

## Migration Guide

> This section is optional.
> If this PR creates a breaking change,
> please indicate the steps needed
> for the user to migrate to the new version.
> Otherwise, feel free to delete this section.

- A guideline to determine whether the changes are breaking can be found [here](https://doc.rust-lang.org/cargo/reference/semver.html).