From 3cd91b7fb4fedd4369bdac21232282f78f45e59f Mon Sep 17 00:00:00 2001
From: jdeschamps <6367888+jdeschamps@users.noreply.github.com>
Date: Fri, 6 Dec 2024 15:58:34 +0100
Subject: [PATCH] chore: Add templates

---
 .github/ISSUE_TEMPLATE/bug_report.md          | 52 ++++++++++++-------
 .github/ISSUE_TEMPLATE/example_report.md      | 24 +++++++++
 .github/ISSUE_TEMPLATE/feature_request.md     | 22 ++++----
 .../interoperability_request.md               | 24 +++++++++
 .github/ISSUE_TEMPLATE/question.md            | 13 +++++
 5 files changed, 106 insertions(+), 29 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/example_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/interoperability_request.md
 create mode 100644 .github/ISSUE_TEMPLATE/question.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 71d52fcd..416f398b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,34 +1,50 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Create a report to help us improve CAREamics
 title: "[BUG]"
 labels: bug
 assignees: ''
-
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Describe the bug
+<!-- A clear and concise description of what the bug is. -->
+
+[description here]
+
+## To Reproduce
 
-**To Reproduce**
 Code snippet allowing reproducing the behaviour:
 ```python
-# code here
+# [code here]
+
+```
+
+Error message:
+``` python
+# [copy your error message here]
 ```
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+## System
+<!-- Please fill in the following information, you can check the package versions using `conda list` -->
+> [!IMPORTANT]
+> - OS: [e.g. iOS]
+> - Python version [e.g. 3.9]
+> - PyTorch version [e.g. 2.3]
+> - PyTorch lightning version [e.g. 2.4]
+> - CAREamics version [e.g. 0.0.4]
+
+### Environment
+<!-- Please copy here the content of your environment, you can use `conda env export > environment.yml` in unix-style command. -->
+
+```yaml
+# [your environment here]
+```
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Version [e.g. 22]
-- microscopy-portfolio version [e.g. 0.0.5]
+## Additional context
 
-**Environment:**
-Please add here the content of your conda environment with versions.
+<!-- Add any other context about the problem here. -->
 
-**Additional context**
-Add any other context about the problem here.
+[additional context here (if applicable)]
diff --git a/.github/ISSUE_TEMPLATE/example_report.md b/.github/ISSUE_TEMPLATE/example_report.md
new file mode 100644
index 00000000..a614bf40
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/example_report.md
@@ -0,0 +1,24 @@
+---
+name: Example report
+about: Tell us about how you use CAREamics
+title: "[Example]"
+labels: example
+assignees: ''
+---
+
+## Task
+<!-- A description of what you are trying to achieve. -->
+
+[description here]
+
+## Results
+<!-- Description of the results obtained with CAREamics. -->
+
+[description here]
+
+
+## References
+
+<!-- Potential references, such as your preprint or article. -->
+
+[additional context here]
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 11fc491e..368d82d6 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,20 +1,20 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
+about: Suggest an idea for CAREamics
+title: '[Feature]'
+labels: feature
 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 [...]
+## Problem
+<!-- A clear and concise description of what the problem is. -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+[your problem description here]
 
-**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.
+## Potential solution
+<!-- A clear and concise description of what you want to happen. -->
+
+[potential solution here, if applicable]
+
diff --git a/.github/ISSUE_TEMPLATE/interoperability_request.md b/.github/ISSUE_TEMPLATE/interoperability_request.md
new file mode 100644
index 00000000..4d96c380
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/interoperability_request.md
@@ -0,0 +1,24 @@
+---
+name: Interoperability request
+about: Tell us about potential synergies for CAREamics
+title: "[Interoperability]"
+labels: interoperability
+assignees: ''
+---
+
+## Description
+<!-- A clear and concise description of what other software or tool CAREamics could be compatible with. -->
+
+[description here]
+
+## Limitations to interfacing
+<!-- Description of the current limitations and challenges to interfacing CAREamics with this other tool. -->
+
+[description here]
+
+
+## References
+
+<!-- Add any other context, links, publications, guidelines that are relevant to interfacing the tool with other libraries. -->
+
+[additional context here]
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 00000000..08392dfa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,13 @@
+---
+name: Question
+about: Ask us anything about CAREamics
+title: "[Question]"
+labels: question
+assignees: ''
+---
+
+## Question
+<!-- A clear question about CAREamics and how to use it. -->
+
+[question here]
+