From e4fb7708dfeba5d69d404bba52c2b5b251e7c58f Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Tue, 23 Jul 2024 09:24:15 +0200 Subject: [PATCH 1/4] Add basic contributing file --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..691e17a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +[![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! 🎉 + +## Feature Requests +We welcome new feature requests! Please open an issue here and describe: + +- The problem you're facing. +- A possible solution or feature. + +## Reporting Bugs + +If you find a bug, please open an issue here and include: + +- A clear, descriptive title. +- Steps to reproduce the bug. +- Your environment (OS, Python version, etc.). + +## 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! + From d2dced3739c6674bce840c3a47e1c3fa1b12745e Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Tue, 23 Jul 2024 09:25:54 +0200 Subject: [PATCH 2/4] Add missing links --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 691e17a..33d21bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,14 +6,14 @@ First off, thanks for taking the time to contribute! 🎉 ## Feature Requests -We welcome new feature requests! Please open an issue here and describe: +We welcome new feature requests! Please open an issue [here](https://github.com/BrainLesion/BraTS/issues) and describe: - The problem you're facing. - A possible solution or feature. ## Reporting Bugs -If you find a bug, please open an issue here and include: +If you find a bug, please open an issue [here](https://github.com/BrainLesion/BraTS/issues) and include: - A clear, descriptive title. - Steps to reproduce the bug. From 58c43cd413518a0778ef762abab304b0388fe336 Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Tue, 23 Jul 2024 09:31:03 +0200 Subject: [PATCH 3/4] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 76 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++ .github/ISSUE_TEMPLATE/question.md | 11 ++++ 3 files changed, 107 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e2dfe26 --- /dev/null +++ b/.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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.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. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..f7af62c --- /dev/null +++ b/.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 [...] From 5ac644099e962da83631841534206198eca4a686 Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Tue, 23 Jul 2024 09:33:30 +0200 Subject: [PATCH 4/4] Add reference to issue templates --- CONTRIBUTING.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33d21bb..278e0c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,19 +5,9 @@ First off, thanks for taking the time to contribute! 🎉 -## Feature Requests -We welcome new feature requests! Please open an issue [here](https://github.com/BrainLesion/BraTS/issues) and describe: - -- The problem you're facing. -- A possible solution or feature. - -## Reporting Bugs - -If you find a bug, please open an issue [here](https://github.com/BrainLesion/BraTS/issues) and include: - -- A clear, descriptive title. -- Steps to reproduce the bug. -- Your environment (OS, Python version, etc.). +## 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.