Skip to content

Commit

Permalink
Merge pull request #317 from GispoCoding/new-tool-issue-template
Browse files Browse the repository at this point in the history
Add issue templates for new tool requests and bug reports
  • Loading branch information
nmaarnio authored Oct 22, 2024
2 parents 770ce79 + 118c2bf commit 66d9aca
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: "Bug report"
about: Report a bug or other issue
title: "[Bug]: "
labels: bug
assignees: ''

---

**Describe the bug**
Describe what the bug or issue is about concisely.

**How to reproduce the bug**
Steps to reproduce the behavior:

**Expected behavior**
Describe what you expected to happen.

**Environment details**
- OS: [e.g., Windows, MacOS]
- Python Version: [e.g., 3.9]
- Package Version: [e.g., 1.2.0]

**Additional information**
Add any other context about the problem here. Screenshots or other additional information can be attached too.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/tool-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Tool request
about: Suggest a new tool to EIS toolkit
title: "[New tool] -"
labels: enhancement
assignees: ''

---

**Tool description**
Please describe what the tool does. Ex. "This tool calculates distances to known deposits"

**Justification and importance**
Please give reasoning why the tool is needed. Is the tool essential or a nice-to-have?

**Tool category and type**
The current categories are the directories under `eis_toolkit` package in this repository. You may also suggest a new category if a suitable one doesn't exist.

**Implementation details**
What does the tool take as input and what is its output? Ex. "The tool takes raster data as input and outputs decimal numbers as an array". Is there a ready made library that already contains the desired functionality or should it be implemented from scratch? Is the library already part of EIS toolkit?

**Who will implement the tool?**
Are you ready to implement the tool yourself or will you hope someone else to do it?

**Additional information**
Any additional information e.g. usage examples, screenshots, links to scientific studies and other documents.

0 comments on commit 66d9aca

Please sign in to comment.