Skip to content

Commit

Permalink
Add templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jdeschamps committed Dec 6, 2024
1 parent 53de458 commit 86ff1a0
Show file tree
Hide file tree
Showing 6 changed files with 169 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Bug report
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. -->

[description here]

## To Reproduce

Code snippet allowing reproducing the behaviour:
```python
# [code here]

```

Error message:
``` python
# [copy your error message here]
```

<!-- 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]
```


## 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]
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for CAREamics
title: '[Feature]'
labels: feature
assignees: ''

---

## Problem
<!-- A clear and concise description of what the problem is. -->

[your problem description 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]
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
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]
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/refactoring_suggestion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Refactoring suggestion
about: Suggest a way to improve CAREamics' codebase
title: "[Refactoring]"
labels: refactoring
assignees: ''
---

## Description
<!-- A description of the current pain points. -->

[description here]

### Which part of the code?

- [links to code]

### Examples

``` python
# [example of the pain points and their consequences]
```

## Potential solutions

<!-- Describe potential solutions in different sections. -->

### [Name of Solution 1]

<!-- A description of a potential solution. -->

``` python
# [suggested change to code for Solution 1]
```

## References

<!-- Add any other context, links to other codebase, PEP, best practices, etc. that could help understand or validate the solution -->

[additional context here]

0 comments on commit 86ff1a0

Please sign in to comment.