Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
nmichlo authored Mar 17, 2021
1 parent dacee84 commit 6780447
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Bug Report
about: Create a bug report to help us improve
title: "[BUG]: <your title here>"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behaviour.

**Expected behaviour**
A clear and concise description of what you expected to happen.

**Additional context**
Add any other context about the problem here, including any relevant system information and python version.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Bug report
about: Create a bug report to help us improve
title: "[BUG]"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behaviour.

**Expected behaviour**
A clear and concise description of what you expected to happen.

**Additional context**
Add any other context about the problem here, including any relevant system information and python version.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature Request
about: Suggest an idea for this project
title: "[FEATURE]: <your title here>"
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE]"
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/framework-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Framework Request
about: Suggest for a new framework to be added to this project
title: "[FRAMEWORK]: <framework name here>"
labels: enhancement
assignees: ''

---

**Which framework would you like added to this project**
- framework name
- link to academic paper

**Why should this framework be added?**
What benefit is there to adding this framework?

**Short summary of framework**
What is the core algorithmic idea behind the framework in simple terms. Please give a general overview rather than advanced algorithmic concepts.
- eg. The beta-VAE weights the regularisation term, aiming to improve disentanglement.
- e.g The DFC-VAE augments the reconstruction loss of the VAE/beta-VAE with a perceptual loss.

**Which framework does this build upon, if any?**
eg. the beta-VAE extends the standard VAE
eg. the Adaptive VAEs extend the beta-VAE

**Are you willing to submit a PR?**
Are you willing to work on this implementation and submit a PR?
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Question
about: Ask a question about this project
title: "[Q]: <your title here>"
labels: question
assignees: ''

---

**Ask Away!**

- Please double check the [docs](https://disent.dontpanic.sh) to make sure that your question is not already answered there.
- Please double check the issues to make sure that your question has not been answered before.

0 comments on commit 6780447

Please sign in to comment.