Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update issue templates #66

Merged
merged 3 commits into from
Apr 10, 2024
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
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug Report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Summary**

(Summarize the bug encountered concisely)

**Mem3DG version**

(Paste the output of `pymem3dg.__version__` if you are using pymem3dg or value of `mem3dg::MEM3DG_VERSION` here.)

**Steps to reproduce**

(Please describe how we can reproduce the bug, and share all files needed. Submitting a minimal working example isolating the issue will improve response time.)

**What is the current bug behavior?**

(What actually happens)

**What did you expect the correct behavior to be?**

(What you should see instead)

**Possible fixes**

(Any suggestions or thoughts are welcome. If you can, link to the line of code that might be responsible for the problem)
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**Summary**

(Why would this be useful?)

**Use cases**

(Describe how the feature will make a difference - from a user point of view, not just developers.)

**Impact**

(What users would this matter to? Is it likely to have large impact relative to the amount of work required?)

**Detailed description**

(Describe the feature in detail. If this is e.g. a new algorithm you developed, are there a lot of people who have cited the paper, or other implementations available? How does it go beyond the current state of the code?)

**Requirements**

(Is there other stuff needed?)

**Links/references/implementations**

(Having a link to a paper can be a nice addition to a detailed description, but it's unlikely developers will have time to e.g. go and read a paper if you didn't have time to describe the feature in detail here. Would you be willing to write the implementation?)