diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..416f398 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,50 @@ +--- +name: Bug report +about: Create a report to help us improve CAREamics +title: "[BUG]" +labels: bug +assignees: '' +--- + +## Describe the bug + + +[description here] + +## To Reproduce + +Code snippet allowing reproducing the behaviour: +```python +# [code here] + +``` + +Error message: +``` python +# [copy your error message here] +``` + + + +## System + +> [!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 + + +```yaml +# [your environment here] +``` + + +## Additional context + + + +[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 0000000..a614bf4 --- /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 + + +[description here] + +## Results + + +[description here] + + +## References + + + +[additional context here] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..ba7d57a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for CAREamics +title: '[Feature]' +labels: feature +assignees: '' + +--- + +## Problem + + +[your problem description here] + + +## Potential solution + + +[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 0000000..4d96c38 --- /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 + + +[description here] + +## Limitations to interfacing + + +[description here] + + +## References + + + +[additional context here] diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..3777f86 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,12 @@ +--- +name: Question +about: Ask us anything about CAREamics +title: "[Question]" +labels: question +assignees: '' +--- + +## Question + + +[question here] diff --git a/.github/ISSUE_TEMPLATE/refactoring_suggestion.md b/.github/ISSUE_TEMPLATE/refactoring_suggestion.md new file mode 100644 index 0000000..9a47d01 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactoring_suggestion.md @@ -0,0 +1,40 @@ +--- +name: Refactoring suggestion +about: Suggest a way to improve CAREamics' codebase +title: "[Refactoring]" +labels: refactoring +assignees: '' +--- + +## Description + + +[description here] + +### Which part of the code? + +- [links to code] + +### Examples + +``` python +# [example of the pain points and their consequences] +``` + +## Potential solutions + + + +### [Name of Solution 1] + + + +``` python +# [suggested change to code for Solution 1] +``` + +## References + + + +[additional context here]