Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add repository issue templates #4148

Merged
merged 3 commits into from
Jun 9, 2020

Conversation

chrisjsewell
Copy link
Member

As the title suggests! I have also copied them to this repository, so you can see how they look: https://github.com/chrisjsewell/issues_test/issues/new/choose

closes #4121

@codecov
Copy link

codecov bot commented Jun 4, 2020

Codecov Report

Merging #4148 into develop will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #4148      +/-   ##
===========================================
+ Coverage    78.89%   78.89%   +0.01%     
===========================================
  Files          467      467              
  Lines        34481    34481              
===========================================
+ Hits         27199    27200       +1     
+ Misses        7282     7281       -1     
Flag Coverage Δ
#django 70.82% <ø> (ø)
#sqlalchemy 71.69% <ø> (-<0.01%) ⬇️
Impacted Files Coverage Δ
aiida/transports/plugins/local.py 80.47% <0.00%> (+0.26%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5b89d6f...170b546. Read the comment docs.

@greschd
Copy link
Member

greschd commented Jun 4, 2020

I'd be in favor of adding a "blank" template, for cases which don't neatly fall into one of the categories.

For example, #3764 is a bug report / feature request where the user has already identified the root cause of the issue. In that case, I think adding all the environment / steps to reproduce / etc. of the bug report is just unnecessary noise.

Of course you can just delete the template once selected, but it creates a mental barrier to doing so.

@chrisjsewell
Copy link
Member Author

I'd be in favor of adding a "blank" template, for cases which don't neatly fall into one of the categories.

Note, there is the option for this at the bottom of the form:

image

@greschd
Copy link
Member

greschd commented Jun 4, 2020

Ah, yeah.. guess I missed it because it doesn't get that much screen real estate. Anyway, in that case I think it's fine as is.

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Jun 4, 2020

Yes I imagine when any of us open an issue, we will probably just use the blank template, in which case this is unnecessary boiler plate. But for new users I think it could be quite useful, and allows us to also point them towards other places they can look first; like the troubleshooting documentation and the mailing list.
But anyway, I will leave it to @giovannipizzi and @sphuber to decide if they think it is worthwhile 😁

@sphuber
Copy link
Contributor

sphuber commented Jun 4, 2020

Is there anyway to test and see what this looks like? In principle I am not opposed but so far we have had very little issues from external users that are not clear enough, so currently I don't feel this is really necessary. This might of course change in the future. I definitely would want that it stays really easy to create issues for ourselves the way we used to, without having to jump through too many hoops.

@chrisjsewell
Copy link
Member Author

Is there anyway to test and see what this looks like?

I don't know of a way to preview directly on this repo, but as I mention above, this link is a direct replica of what you will see:
https://github.com/chrisjsewell/issues_test/issues/new/choose

@sphuber
Copy link
Contributor

sphuber commented Jun 4, 2020

So for us to create an issue we would have an intermediate page where we need to click on one button and then remove the context. This is not too much of a hassle, but I doubt that the benefits really outweigh the downsides for now, simply since it is mostly us creating the majority of issues and we don't really need to be that specific oftentimes

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Jun 4, 2020

click on one button and then remove the context.

Yes it's essentially an extra click, but you don't need to remove anything just click on the bottom blank issue link:

image

but I doubt that the benefits really outweigh the downsides for now

I'm not too fussed either way, just wanted to bring it up as a suggestion

@sphuber
Copy link
Contributor

sphuber commented Jun 4, 2020

I'm not too fussed either way, just wanted to bring it up as a suggestion

Cheers for that. I think it is not necessary right now, but I don't mind adding it either if others think it is a useful addition.

Copy link
Member

@giovannipizzi giovannipizzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of adding one click (and I agree that the 'blank' option is a bit invisible - but people can just delete the text so ok).
But maybe it's ok to make sure people write in the ML if it's just a question, so I'm approving this. Happy for anybody else to merge if at least another person is OK.

@sphuber
Copy link
Contributor

sphuber commented Jun 9, 2020

OK, in that case we will add it for now. If we get reports that is disturbs more than that it helps, we can remove it

@chrisjsewell
Copy link
Member Author

OK, in that case we will add it for now. If we get reports that is disturbs more than that it helps, we can remove it

👍
I've personally found it helpful on repos, especially when getting lots of "new users" raising issues. But if it becomes a hindrance to developers, then by all means drop it

@sphuber sphuber merged commit 4b0a7ee into aiidateam:develop Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Issue Templates for GitHub
4 participants