Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
clementpoiret authored Oct 27, 2021
1 parent e9a2308 commit 880fd70
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

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

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

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

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**
- OS: [e.g. Debian]
- Python: [e.g. 3.9.1]
- HSF Version: [e.g. 0.1.1]
- Relevant settings: [e.g. segmentation=bagging_fast]

**Additional context**
Add any other context about the problem here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/data-submission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Data Submission
about: Help us improve our models by sending us your data or suggesting us new datasets.
title: ''
labels: enhancement
assignees: ''

---

Please be aware that your private data will stay private. We understand privacy issues, and HSF will NOT release any dataset on its own. Your MRIs will stay private, securely stored in specific storage infrastructures inaccessible from the Internet at the Commissariat à l'Energie Atomique et aux Energies Alternatives (CEA) of Paris-Saclay, France. Your MRIs will ONLY be used for offline training of our Deep Learning models.

**Do you open this issue because of an issue in HSF? Please describe.**
A clear and concise description of what the problem is with HSF leading you to gather new segmented MRIs (e.g. bad segmentation in pathological subjects).

**Is the dataset yours? How to cite it?**
A clear and concise description of where does the data comes from, and the conditions to use the MRIs.

**Dataset description**
A clear and concise description of any included MRI (e.g. 71 T1w MRIs, MP2RAGE, 0.8*0.8*0.8mm) with manually corrected segmentations (HSF bagging accurate as base).

**How to access the dataset?**
Please provide a link if the dataset is public, or provide a way to discuss this in private if the dataset has to stay private.
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: ''
labels: enhancement, help wanted
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.

0 comments on commit 880fd70

Please sign in to comment.