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

Templates for issue types and update PR template #22

Merged
merged 1 commit into from
Aug 17, 2018
Merged
Show file tree
Hide file tree
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: 0 additions & 33 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Report a problem/bug to help us improve

---

**Description of the problem**



<!-- Please be as detailed as you can when describing an issue. The more information we have, the easier it will be for us to track this down. -->

**Full script that generated the error**

<!-- It helps a lot if you share any data files required to run your script. You can drag-and-drop them here or paste a link to Dropbox/GoogleDrive/etc. -->

```
PASTE CODE HERE
```


**Full error message**

<!-- Tip: you'll get more detailed error messages if you add -Vd to your gmt commands. -->

```
PASTE ERROR MESSAGE HERE
```


**System information**

* Operating system:
* Version of GMT:
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature request
about: Request the addition of a new feature/functionality

---

**Description of the desired feature**



<!-- 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 or figure). -->


**Are you willing to help implement and maintain this feature?** Yes/No

<!-- 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. -->
17 changes: 14 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
*Detailed description of changes proposed and why you made them.
If unsure, open an issue first so we can discuss it.
If fixing an issue, put the issue number after the # below (no spaces).*
**Description of proposed changes**



<!-- Please describe changes proposed and **why** you made them. If unsure, open an issue first so we can discuss.-->

<!-- If fixing an issue, put the issue number after the # below (no spaces). Github will automatically close it when this gets merged. -->
Fixes #


**Reminders**

- [ ] Make sure that your code follows our style. Use the other functions/files as a basis.
- [ ] Add tests for new features or tests that would have caught the bug that you're fixing.
- [ ] Describe changes to function behavior and arguments in a comment below the function declaration.
- [ ] If adding new functionality, add a detailed description to the documentation and/or an example.
1 change: 0 additions & 1 deletion .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ newPRWelcomeComment: |

A few things to keep in mind:

* Make sure that your code follows our style. Use the other functions/files as a basis.
* 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.
* All new features should be documented. It helps to write the comments below for your functions describing the it, **all** arguments, and return types before writing the code. This will help you think about your code design and results in better code.
* We are grateful that you put in the effort to do this! 🎉
Expand Down