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

Added milestones and issue search links to the issue template #2258

Merged
merged 2 commits into from
Jan 22, 2017

Conversation

besh
Copy link

@besh besh commented Jan 14, 2017

Which issue, if any, is this issue related to?

#2256

Is there anything in the PR that needs further explanation?

I didn't check the v8 changelog before creating a duplicate bug report. Having this message in the issue template could help prevent myself and others from doing that in the future.

@davidtheclark
Copy link
Contributor

I'm not sure this is necessary. That means part of the issue template will have to change as we do future releases. We could add a note that you should search through issues and pull requests in the repo to see if your concern has come up before — everybody should always do that for any repo before submitting an issue.

@besh
Copy link
Author

besh commented Jan 14, 2017

That means part of the issue template will have to change as we do future releases

@davidtheclark I think that's a fair assumption, but in the case of v8, it doesn't have an official release date so I could see this one line hanging out for a little bit. Obviously I'm speculating on how far out the release might be.

In this case, the master changelog doesn't show anything related to this bug fix (which makes sense as it's not in any current releases). I had no idea that there was a v8 release coming out either.

Of course it's my fault for not digging through the closed PRs/issues or checking the other branches, but I think that for the cases where you have other people who are lazy like me, this could help prevent the bug being from being filed. If I'm the only one who is too lazy to keep digging, then you're probably right that this isn't required at all.

@besh
Copy link
Author

besh commented Jan 14, 2017

everybody should always do that for any repo before submitting an issue

Also a fair point but I would argue that all the things that are listed under "Here are the best ways to help resolve your issue:" are things that we should always be mindful of when contributing/opening an issue on a repo. The point of a template and little reminder notes like that are because we know that without them, popular repos will have a lot of incoming duplicate or one-liner bug reports without steps to reproduce.

I don't see the harm in adding a helpful reminder like you describe as it's a win/win for all but obviously this is your call!

@jeddy3
Copy link
Member

jeddy3 commented Jan 15, 2017

How about a note about checking if the issue is resolved in an upcoming major milestone? e.g.

<!--
Before posting, please check that your issue:
1. Hasn't already been resolved in:
  - the next release (https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md)
  - an upcoming major milestone (https://github.com/stylelint/stylelint/milestones)
2. Hasn't already been discussed (https://github.com/stylelint/stylelint/search)
-->

<!--
Here are the best ways to help resolve your issue:
1. Figure out what needs to be done, propose it, and then write the code and submit a PR.
2. If your issue is a bug, consider at least submitting a PR with failing tests.
-->

This means we won't need to update the issue after each release, and I think it also addresses @hankthewhale concerns

I've updated the 8.0.0 description to include a link to the v8 branch CHANGELOG either way as that's handy to have on show.

Copy link
Contributor

@davidtheclark davidtheclark left a comment

Choose a reason for hiding this comment

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

OK, @jeddy3's idea seems good.

@besh
Copy link
Author

besh commented Jan 15, 2017

This all sounds good to me. I'll make the update today.

@besh
Copy link
Author

besh commented Jan 16, 2017

@davidtheclark @jeddy3 alright fellas. Made the requested changes!

Copy link
Member

@ntwb ntwb left a comment

Choose a reason for hiding this comment

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

LGTM

@jeddy3
Copy link
Member

jeddy3 commented Jan 16, 2017

@hankthewhale Thanks very much :)

@davidtheclark Can you merge after your review please?

@besh besh changed the title Added link to v8 changelog in the issue template Added milestones and issue search links to the issue template Jan 16, 2017
@besh
Copy link
Author

besh commented Jan 16, 2017

Changed the PR description to match what's actually happening now.

@davidtheclark davidtheclark merged commit 97dfa5e into stylelint:master Jan 22, 2017
@besh besh deleted the v8-changelog-issue-template branch January 24, 2017 12:48
sergesemashko pushed a commit to sergesemashko/stylelint that referenced this pull request Mar 3, 2017
…int#2258)

* Added link to v8 changelog in the issue template

* add milestone and search links to issue template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants