-
Notifications
You must be signed in to change notification settings - Fork 346
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Templates for issue types and update PR template (#22)
Github allows using different templates for different types of issues. I created one for bug reports and one for feature requests. We can add as many as we want later ("questions" for example). Update the PR template with a checklist of reminders to make sure the code is following the general style, has documentation, tests, etc.
- Loading branch information
1 parent
4eb6cb0
commit 49baf49
Showing
5 changed files
with
64 additions
and
37 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters