Merge pull request #9 from BrainLesion/4-feature-add-contributingmd

Add basic contributing file

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,76 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**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
+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
+```
+
+### Docker version
+please specify your docker version, You can find it by running: 
+```sh
+docker --version
+```
+
+### Version of brats ?
+please specify your version of brats (please make sure you run the latest version):
+```sh
+pip freeze | grep brats
+```
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+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 [...]
+
+**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,11 @@
+---
+name: Question
+about: Please ask your question, make sure to read the FAQ before
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Your question**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![License: GPLv3](https://img.shields.io/badge/License-AGPLv3-blue.svg)](https://www.gnu.org/licenses/Agpl-3.0)
+
+# Contributing to BraTS
+
+First off, thanks for taking the time to contribute! 🎉
+
+## Reporting Bugs, Feature Requests and Questions
+Please open a new issue [here](https://github.com/BrainLesion/BraTS/issues).
+Using our issue templates will make the process easier and faster for us all!
+
+## Contribute Code 
+Fork the repository, clone it and implement your contribution.
+
+**Setup:**
+- We use [poetry](https://python-poetry.org/), make sure it is installed: `pip install poetry`
+- Install dependencies by running: `poetry install`
+
+**Requirements:**
+- Our project follows the [black code style](https://github.com/psf/black). Make sure your code is formatted correctly.
+- Please add _meaningful_ docstring for your functions and annotate types
+- Please add _meaningful_ tests for your contribution in `/tests` and make sure _all_ tests are passing by running `python -m pytest`
+
+
+
+Once done, create a Pull Request to integrate the code in to our project!
+