Skip to content

Commit 9bc7838

Browse files
committed
Add new template for feature requests and PR
The PR template includes a checklist of common tasks that need to be done.
1 parent e99e15f commit 9bc7838

File tree

5 files changed

+32
-42
lines changed

5 files changed

+32
-42
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Report a problem/bug to help us improve
44

55
---
66

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request
3+
about: Request the addition of a new feature/functionality
4+
5+
---
6+
7+
**Description of the desired feature**
8+
9+
10+
11+
<!-- Please be as detailed as you can in your description. If possible, include an example of how you would like to use this feature (even better if it's a code example). -->
12+
13+
14+
**Are you willing to help implement and maintain this feature?** Yes/No
15+
16+
<!-- Every feature we add is code that we will have to maintain and keep updated. This takes a lot of effort. If you are willing to be involved in the project and help maintain your feature, it will make it easier for us to accept it. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1-
*Detailed description of changes proposed and why you made them.
2-
If unsure, open an issue first so we can discuss it.
3-
If fixing an issue, put the issue number after the # below (no spaces).*
1+
**Description of proposed changes**
42

3+
4+
5+
<!-- Please describe changes proposed and **why** you made them. If unsure, open an issue first so we can discuss.-->
6+
7+
<!-- If fixing an issue, put the issue number after the # below (no spaces). Github will automatically close it when this gets merged. -->
58
Fixes #
9+
10+
11+
**Reminders**
12+
13+
- [ ] Run `make format` and `make check` to make sure the code follows the style guide.
14+
- [ ] Add tests for new features or tests that would have caught the bug that you're fixing.
15+
- [ ] Add new public functions/methods/classes to `doc/api/index.rst`.
16+
- [ ] Write detailed docstrings for all functions/methods.
17+
- [ ] If adding new functionality, add an example to docstrings or tutorials.

.github/config.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ newPRWelcomeComment: |
1212
1313
A few things to keep in mind:
1414
15-
* Remember to run ``make format`` to make sure your code follows our style guide.
1615
* If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
1716
* All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
1817
* No matter what, we are really grateful that you put in the effort to do this! 🎉

0 commit comments

Comments
 (0)