Merge pull request #45 from BrainLesion/40-feature-request-we-need-issue-templates-to-get-more-meaningful-issues

40 feature request we need issue templates to get more meaningful issues

Author: neuronflow

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,74 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+> [!NOTE]
+> If you encounter a bug related to one of the packages used in the tutorial, please report it in the GitHub repository of the relevant package, rather than in the tutorial repository itself.
+
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Install '....'
+3. Run commands '....'
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment**
+
+### operating system and version?
+e.g. Ubuntu 23.10 LTS
+
+
+### NVIDIA drivers and GPUs (if applicable)
+please paste the output of (or a more suitable base version for your system):
+```sh
+nvidia-smi
+```
+
+You should see something like:
+```
++---------------------------------------------------------------------------------------+
+| NVIDIA-SMI 530.30.02              Driver Version: 530.30.02    CUDA Version: 12.1     |
+|-----------------------------------------+----------------------+----------------------+
+| GPU  Name                  Persistence-M| Bus-Id        Disp.A | Volatile Uncorr. ECC |
+| Fan  Temp  Perf            Pwr:Usage/Cap|         Memory-Usage | GPU-Util  Compute M. |
+|                                         |                      |               MIG M. |
+|=========================================+======================+======================|
+|   0  NVIDIA RTX A5000                Off| 00000000:01:00.0 Off |                  Off |
+| 30%   17C    P8               12W / 230W|      6MiB / 24564MiB |      0%      Default |
+|                                         |                      |                  N/A |
++-----------------------------------------+----------------------+----------------------+
+|   1  Quadro RTX 8000                 Off| 00000000:C1:00.0 Off |                  Off |
+| 33%   17C    P8                9W / 260W|      6MiB / 49152MiB |      0%      Default |
+|                                         |                      |                  N/A |
++-----------------------------------------+----------------------+----------------------+
+```
+
+
+### Python environment and version?
+e.g. Conda environment with Python 3.10. Check your Python version with:
+```sh
+python --version
+```
+
+### version of brainles_preprocessing ?
+please specify your version of brainles_preprocessing (please make sure you run the latest version):
+```sh
+pip freeze | grep brainles_preprocessing
+```
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+> [!NOTE]
+> If you have a feature request concerning one of the packages used in the tutorial, kindly submit it to the GitHub repository of the respective package, instead of the tutorial repository.
+> 
+**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.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,14 @@
+---
+name: Question
+about: Please ask your question, make sure to read the FAQ before
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+> [!NOTE]
+> If you have a question regarding one of the packages used in the tutorial, please feel free to ask it in the GitHub repository of the relevant package, rather than in the tutorial repository itself.
+
+**Your question**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]