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

Adds issue and pull request templates #311

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug/Crash report but not related to a third party API (see other options below)
about: Report a bug in the codebase or a crash
labels:
---
<!--
Thank you for filing a bug report! 🐛 Please provide a short summary of the bug,
along with any information you feel relevant to replicating the bug. Always try to
provide the data you used in your example as otherwise it can be difficult to
reporduce the bug.
-->

## Description
I tried this code:

```
<code>
```

I expected to see this happen: *explanation*

Instead, this happened: *explanation*

Here is a link to download the data I used:

## Metadata
- WhiteboxTools version:
- API used if (Python, R, QGIS, ArcMap):
- Operating System version:

*Note that WhiteboxTools Open Core (WbTOC) and Whitebox Workflows for Python (WbW) are not the same software. Only WhiteboxTools Open Core is available in this repository.*
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
blank_issues_enabled: false

contact_links:
- name: WhiteboxTools Google Group
url: https://groups.google.com/g/whiteboxtools
about: Ask and answer questions about Whitebox tools here.

- name: WhiteboxTools on GIS StackExchange
url: https://gis.stackexchange.com/questions/tagged/whitebox-tools
about: Ask and answer questions about Whitebox tools here.

- name: ArcGIS plugin
url: https://github.com/giswqs/WhiteboxTools-ArcGIS/issues
about: Report an issue with the ArcGIS plugin.

- name: R package
url: https://github.com/giswqs/whiteboxR/issues
about: Report an issue with the R package.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Request for a new feature to be added
labels: feature request
---

## Request
<!--
Provide details about what you are looking for.

See [How do I request a tool to be added?](https://www.whiteboxgeo.com/manual/wbt_book/faq.html#how-do-i-request-a-tool-be-added) if you are looking for tools from Whitebox GAT.
See [How does WhiteboxTools' design philosophy differ?](https://www.whiteboxgeo.com/manual/wbt_book/faq.html#how-does-whiteboxtools-design-philosophy-differ) to learn more about why WhiteboxTools is the way it is.
-->

## Drawbacks
<!--Does this new feature will cause any issue with other parts of WhiteboxTools?-->

## Usage example
<!--In which situation would it be useful?-->
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!--- Provide a general summary of your changes in the title above -->

## Description
<!--- Describe your changes in detail -->

## Related issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->

## Motivation and context
<!--- Why is this change required? What problem does it solve? -->

## How has this been tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):