Nilearn: Improve Issue Templates

Created on 8 Dec 2020  路  4Comments  路  Source: nilearn/nilearn

As discussed in last meeting:

TODO:

  • [x] Fix labels in current issue templates which are not added automatically
  • [x] Improve existing templates
  • [x] Add new templates? (Documentation Improvement, Question, others...?)
Enhancement
Source
picture NicolasGensollen

Most helpful comment

Regarding improving the actual templates- what about making the summary comment at the top into specific sections?

For example, for the bug report, instead of

<!--

Include this information:
-------------------------
What version of Nilearn are you using?
What were you trying to do?
What did you expect will happen?
What actually happened?

List the steps you performed that revealed the bug to you.
Include any code samples. Enclose them in triple back-ticks (```)
Like this:



-->

we could have:

Nilearn version: 

### Expected behavior


### Actual behavior


### Code to reproduce

\```python

\```
picture tsalo on 1 Feb 2021
👍2

All 4 comments

It would be great to have a link on the issue template choice page that goes directly to NeuroStars for usage questions. I think that should be possible with a config file (see here). +1 for a documentation improvement template as well.

EDIT: I just added a NeuroStars link to NiMARE and it looks pretty good:

image

tsalo picture tsalo on 6 Jan 2021
👍2

+1 for a link to Neurostars !

bthirion picture bthirion on 6 Jan 2021

Regarding improving the actual templates- what about making the summary comment at the top into specific sections?

For example, for the bug report, instead of

<!--

Include this information:
-------------------------
What version of Nilearn are you using?
What were you trying to do?
What did you expect will happen?
What actually happened?

List the steps you performed that revealed the bug to you.
Include any code samples. Enclose them in triple back-ticks (```)
Like this:



-->

we could have:

Nilearn version: 

### Expected behavior


### Actual behavior


### Code to reproduce

\```python

\```
tsalo picture tsalo on 1 Feb 2021
👍2

I like the idea! :+1:
I think the template is more clear and this will perhaps encourage user to copy-paste their code to reproduce.

NicolasGensollen picture NicolasGensollen on 1 Feb 2021
Was this page helpful?
0 / 5 - 0 ratings

Related issues

celinede picture celinede  路  7Comments
kchawla-pi picture kchawla-pi  路  5Comments
JohannesWiesner picture JohannesWiesner  路  6Comments
AmericaBG picture AmericaBG  路  4Comments
xuesongwang picture xuesongwang  路  3Comments