From d7da925cd43879165401aa62e455462a7df113b8 Mon Sep 17 00:00:00 2001 From: Taylor Salo Date: Fri, 28 Jul 2023 10:23:40 -0400 Subject: [PATCH 1/3] Draft issue templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 33 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 4 +++ .github/ISSUE_TEMPLATE/feature_request.md | 16 +++++++++++ 3 files changed, 53 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..9ff7b547 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Something not working as described? Missing/incorrect documentation? This is the place. +title: '' +labels: 'bug' +assignees: '' + +--- +## Summary + + +## Additional details + +- BABS version: +- Docker version: +- Singularity version: + +### What were you trying to do? + +### What did you expect to happen? + +### What actually happened? + +## Reproducing the bug + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..5bb4ecd2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: Usage question + url: https://neurostars.org/tags/c/software-support/234/babs + about: Please ask questions about using BABS on NeuroStars. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..f3d8ef67 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Got an idea for a new feature, or changing an existing one? This is the place. +title: '' +labels: 'enhancement' +assignees: '' + +--- +## Summary + + +## Additional details + + +## Next steps + From 77d9289cfcc931022de51baa61bcb5595e596106 Mon Sep 17 00:00:00 2001 From: Chenying Zhao Date: Fri, 27 Oct 2023 11:47:14 -0400 Subject: [PATCH 2/3] add more detailed questions in bug report issue template; remove link to neurostars --- .github/ISSUE_TEMPLATE/bug_report.md | 10 +++++++--- .github/ISSUE_TEMPLATE/config.yml | 4 ---- 2 files changed, 7 insertions(+), 7 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9ff7b547..2ec50118 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,9 +11,13 @@ assignees: '' ## Additional details -- BABS version: -- Docker version: -- Singularity version: +- BABS version (`pip show babs`): +- DataLad version (`datalad --version`): +- Git version (`git --version`): +- `git-annex` version (`git-annex version`; pasting the first printed line is sufficient): +- `datalad-container` version (`datalad containers-add --version`): +- Singularity version (`singularity --version`): +- Please copy and paste the printed messages from `babs-check-setup`: ### What were you trying to do? diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 5bb4ecd2..00000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,4 +0,0 @@ -contact_links: - - name: Usage question - url: https://neurostars.org/tags/c/software-support/234/babs - about: Please ask questions about using BABS on NeuroStars. From 2bb7eb4c11e59ebf20dea1a6e97caec118a714d3 Mon Sep 17 00:00:00 2001 From: Chenying Zhao Date: Fri, 27 Oct 2023 11:50:26 -0400 Subject: [PATCH 3/3] add sphinx_rtd_theme to setup.cfg for readthedocs --- setup.cfg | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.cfg b/setup.cfg index c68fda9f..288e627a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -50,6 +50,7 @@ doc = jinja2<3.1.0 # to fix the issue re: jinja2 docutils <0.17 # to fix the issue of bullet points not rendered sphinx_design # for adding in-line badges etc + sphinx_rtd_theme # needed by readthedocs tests = pytest pytest-xdist # for running pytest in parallel