Adding an ISSUE_TEMPLATE.md #4906

Merged
merged 3 commits into from Sep 27, 2016

Projects

None yet

5 participants

@yohanboniface
Member

First suggestion. Thoughts?

@IvanSanchez IvanSanchez and 1 other commented on an outdated diff Sep 11, 2016
ISSUE_TEMPLATE.md
@@ -0,0 +1,20 @@
+- [ ] I'm reporting a bug, not asking for help
+- [ ] I've looked at the [documentation](http://leafletjs.com/reference-1.0.0.html) to make sure this is not a documented behaviour
@IvanSanchez
IvanSanchez Sep 11, 2016 Member

Typo: «not documented behaviour». Maybe it's clearer if the wording is «to make sure the behaviour is documented and expected»

@IvanSanchez IvanSanchez and 1 other commented on an outdated diff Sep 11, 2016
ISSUE_TEMPLATE.md
@@ -0,0 +1,20 @@
+- [ ] I'm reporting a bug, not asking for help
+- [ ] I've looked at the [documentation](http://leafletjs.com/reference-1.0.0.html) to make sure this is not a documented behaviour
+- [ ] I'm sure this is a Leaflet code issue, not an issue with my own code
@IvanSanchez
IvanSanchez Sep 11, 2016 Member

I'd add a line about ionic, cordova, react, ractive, vue and all the other JS frameworks we don't (really) care about.

@IvanSanchez
Member

I'd also add a couple of lines about specifying the browser for browser-specific bugs (or the more generic word "platform" to include phones and such), and also (very important) which version the bug is reproducible in.

@yohanboniface
Member

I'd also add a couple of lines about specifying the browser for browser-specific bugs (or the more generic word "platform" to include phones and such),

Right! :)

and also (very important) which version the bug is reproducible in.

Damn right! :)

@yohanboniface yohanboniface Adding an ISSUE_TEMPLATE.md
1e0af83
@mourner
Member
mourner commented Sep 11, 2016 edited

I like it, although I would maybe simplify some statements and formatting to make the template shorter and simpler (longer templates are less likely to be adhered to).

@yohanboniface
Member

I guess those two sentences can be made shorter:

  • I've looked at the documentation to make sure the behaviour is documented and expected
  • I'm sure this is a Leaflet code issue, not an issue with my own code nor with the framework I'm using (Cordova, Ionic, Angular, React…)

To you have any other idea in mind?

@danzel
Member
danzel commented Sep 11, 2016

The language on this bit could be improved I think:

this example do not imply any third party code

I'm not sure what it is meant to mean.

@perliedman perliedman imply -> rely on
c03b0f8
@perliedman
Member

@danzel a changed "imply" to "rely on", which at least for me makes more sense!

@yohanboniface
Member

Great, thanks Per :)

@mourner
Member
mourner commented Sep 12, 2016

@yohanboniface maybe you meant "does not", not "do not"?

@yohanboniface yohanboniface Fix typo in ISSUE_TEMPLATE
7585523
@yohanboniface
Member

@yohanboniface maybe you meant "does not", not "do not"?

Erf, fixed :p

@mourner mourner merged commit 79778eb into master Sep 27, 2016

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
@mourner mourner deleted the issue-template branch Sep 27, 2016
@mourner mourner removed the in progress label Sep 27, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment