Add github issue templates #197
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 12, 2020
|
Looks nice! Project lead request and release request should cover the most common use cases that come up. These templates should further clarify the purpose of this repository. |
|
I have double-checked and whilst in general users won't be able to edit the labels, the ones listed in the templates will be applied. As such this should close #188 (or at least reduces it to a documentation problem). Additionally, if you add a |
|
@jezdez Just a quick ping since it's been a while.. sorry to bug you. Any chance of a review on this? |
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
|
@hugovk Thanks for taking a look - I agree with all of your suggestions |
hugovk
approved these changes
Sep 29, 2020
|
Thanks all for the work on this, this is a great start! |
jezdez
approved these changes
Oct 2, 2020
This was referenced Oct 2, 2020
jstockwin
added a commit
to jstockwin/website-1
that referenced
this pull request
Oct 2, 2020
Closes jazzband#730 - The old logic would open an issue with a label get parameter, however this didn't work (see jazzband/help#188) - Instead, we have added some issue templates (jazzband/help#197) - The URL to view the template selection is /issues/new/choose - This PR removed the logic for handling, and instead takes users directly to the template selection page. - Strangely, choosing one of these templates seems to add most options into the get params (including labels), but somehow it gets around the permissions issue. - I have also changed the link for if the website is erroring to create an issue on the website repo, rather than the help repo. Note: I could have linked to the resulting issues page once you'd chosen your selection (e.g. "Project lead"), but there are multiple get parameters, and some would need upating if we change the template. I think it's better like this, so we can update the templates without making any other changes. Let me know if you disagree.
jstockwin
added a commit
to jstockwin/website-1
that referenced
this pull request
Oct 2, 2020
Closes jazzband#730 - The old logic would open an issue with a label get parameter, however this didn't work (see jazzband/help#188) - Instead, we have added some issue templates (jazzband/help#197) - The URL to view the template selection is /issues/new/choose - This PR removed the logic for handling, and instead takes users directly to the template selection page. - Strangely, choosing one of these templates seems to add most options into the get params (including labels), but somehow it gets around the permissions issue. - I have also changed the link for if the website is erroring to create an issue on the website repo, rather than the help repo. Note: I could have linked to the resulting issues page once you'd chosen your selection (e.g. "Project lead"), but there are multiple get parameters, and some would need upating if we change the template. I think it's better like this, so we can update the templates without making any other changes. Let me know if you disagree.
jstockwin
added a commit
to jstockwin/website-1
that referenced
this pull request
Oct 2, 2020
Closes jazzband#730 - The old logic would open an issue with a label get parameter, however this didn't work (see jazzband/help#188) - Instead, we have added some issue templates (jazzband/help#197) - The URL to view the template selection is /issues/new/choose - This PR removed the logic for handling, and instead takes users directly to the template selection page. - Strangely, choosing one of these templates seems to add most options into the get params (including labels), but somehow it gets around the permissions issue. - I have also changed the link for if the website is erroring to create an issue on the website repo, rather than the help repo. Note: I could have linked to the resulting issues page once you'd chosen your selection (e.g. "Project lead"), but there are multiple get parameters, and some would need upating if we change the template. I think it's better like this, so we can update the templates without making any other changes. Let me know if you disagree.
jezdez
pushed a commit
to jazzband/website
that referenced
this pull request
Oct 2, 2020
* Update create issue links Closes #730 - The old logic would open an issue with a label get parameter, however this didn't work (see jazzband/help#188) - Instead, we have added some issue templates (jazzband/help#197) - The URL to view the template selection is /issues/new/choose - This PR removed the logic for handling, and instead takes users directly to the template selection page. - Strangely, choosing one of these templates seems to add most options into the get params (including labels), but somehow it gets around the permissions issue. - I have also changed the link for if the website is erroring to create an issue on the website repo, rather than the help repo. Note: I could have linked to the resulting issues page once you'd chosen your selection (e.g. "Project lead"), but there are multiple get parameters, and some would need upating if we change the template. I think it's better like this, so we can update the templates without making any other changes. Let me know if you disagree. * Code review fixes - still send website issues to help repo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #124.
This change causes anyone creating a new issue to be faced with choices. You can see an example of how this looks here.This might be a fairly heavy-weight solution, but it IMO it keeps things nice and explicit.
I've gone for:
Each of these should automatically add the required labels (note: currently there is no
proposallabel, do we want to add one?).This should also help with (if not close) #188. (I'm pretty sure it will add the labels now, even though non-contributors won't be able to edit them, but we'll have to check).
We may want to update the wording on the website after this, as all of the issue links should probably just go to the issue template choice page, and we'll tell them which one to click on?
Regarding the actual content of the templates, you'll probably have some suggested changes since I'm not really familiar with all of the processes involved. The proposal one maybe seems a bit too formal (we don't want to scare people off!), however I do like the simplicity that a list of checkboxes provides.. what do you think?
(small side note: I was initially surprised that I couldn't push directly to this repo, but I guess that makes sense since it's
jazzband-roadiesnotjazzband. I guess not an issue since this repo won't be changed much?)