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 pull request template for improved contribution process #12

Merged
merged 5 commits into from
Sep 15, 2024
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 @@
<!--
Thanks for creating this pull request 🤗

Please limit the pull request to one type (docs, feature, etc.) and keep it as small as possible.

Check notice on line 4 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L4

Expected: 80; Actual: 98
You can open multiple prs instead of opening a huge one.
-->

<!-- If this pull request closes an issue, please mention the issue number below -->

Check notice on line 8 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L8

Expected: 80; Actual: 84
Closes # <!-- Issue # here -->

Check notice on line 9 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L9

First line in a file should be a top-level heading

## 📑 Description

Check notice on line 11 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L11

Expected: [None]; Actual: ## 📑 Description
<!-- Add a brief description of the pr -->

<!--
You can also choose to add a list of changes and if they have been completed or not by using the markdown to-do list syntax

Check notice on line 15 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L15

Expected: 80; Actual: 123
- [ ] Not Completed
- [x] Completed
-->

## ✅ Checks
<!-- Make sure your pr passes the CI checks and check the following fields as needed - -->

Check notice on line 21 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L21

Expected: 80; Actual: 90
- [ ] My pull request adheres to the code style of this project
- [ ] My code requires changes to the documentation
- [ ] I have updated the documentation as required
- [ ] All the tests have passed

## ☢️ Does this introduce a breaking change?
<!-- If this introduces a breaking change, make sure to note it here and what the impact might be -->

Check notice on line 28 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L28

Expected: 80; Actual: 101
- [ ] Yes
- [ ] No

## ℹ Additional Information
<!-- Any additional information like breaking changes, dependencies added, screenshots, comparisons between new and old behavior, etc.-->

Check notice on line 33 in .github/pull_request_template.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/pull_request_template.md#L33

Expected: 80; Actual: 138