Skip to content

Commit

Permalink
chore: Add templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jdeschamps committed Dec 6, 2024
1 parent 9241452 commit 3cd91b7
Show file tree
Hide file tree
Showing 5 changed files with 106 additions and 29 deletions.
52 changes: 34 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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)]
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/example_report.md
Original file line number Diff line number Diff line change
@@ -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]
22 changes: 11 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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]

24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/interoperability_request.md
Original file line number Diff line number Diff line change
@@ -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]
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 us anything about CAREamics
title: "[Question]"
labels: question
assignees: ''
---

## Question
<!-- A clear question about CAREamics and how to use it. -->

[question here]

0 comments on commit 3cd91b7

Please sign in to comment.