Add ISSUE_TEMPLATE.md #2786

chriscool · 2016-06-01T18:46:50Z

This addresses issue #2770.

Kubuxu · 2016-06-01T18:50:43Z

In my opinion we shouldn't be using headers to note informations. It will get a bit annoying.

Also there was talk about adding note at the bottom that is information about that go-ipfs repo is about bug reports and directly actionable features. More complex feature requests and general questions should go into different repos.

chriscool · 2016-06-01T19:07:48Z

There are no headers any more. About the note at the bottom, I think it could get annoying too. Isn't there another place where we could tell that?

Kubuxu · 2016-06-01T19:19:47Z

No, it is the best we have came up with (as a fix for big number of non-actionable issues in the repo). I would place it at the bottom with something like:

---------------------------------------------------
Please read and then delete
go-ipfs issue tracker ....
If that doesn't fit your issue you might want to use one of following repos:
https://github.com/ipfs/notes/isssues - for general notes and ideas
https://github.com/ipfs/faq/issues - for questions
https://github.com/ipfs/specs/issues - for protocol discussions
etc.

chriscool · 2016-06-01T19:35:11Z

Ok, here is a version close to what you suggest.

It seems a bit verbose to me though. Couldn't we just provide one link from where the user could get more information about the appropriate places?

Kubuxu · 2016-06-01T19:41:26Z

This might be a good idea. A central hub to redirect peoples' issues (also this etc. isn't needed in the text itself).

@whyrusleeping what do you think?

chriscool · 2016-06-01T19:52:13Z

etc. has been removed.

We could better detail where issues should be reported here for example:

https://github.com/ipfs/community/blob/master/contributing.md#reporting-issues

Kubuxu · 2016-06-01T19:56:35Z

Yeah, this section needs improvements as well.

I would go with what we've got here (thanks) and possibly improve it in future.

whyrusleeping · 2016-06-01T20:59:23Z

ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+Operating system version & Platform:
+IPFS commit version (from `ipfs version --commit`):
+IPFS repo version (from `ipfs version --repo`):


I don't think we need the repo version, if we know the commit, or even just the general semver we can infer it. It might be better to ask for 'ipfs version (and commit, if known)'

whyrusleeping · 2016-06-01T21:08:00Z

cc @em-ly

em-ly · 2016-06-01T22:44:12Z

Thanks @whyrusleeping. We met today and created some prelimary template outline for the Issues template for https://github.com/ipfs/go-ipfs/

Type:
    bug
    Meta
    question
    test failure
    panic (severe bug)
    enhancement

Platform:
    Linux
    Windows
    Mac
    Etc.

Processor:
    32
    64
    Arm

Area:
    api
    bandwidth reduction
    bit swap
    blockstore
    commands
    containers + vms
    core
    daemon + init
    dat
    discovery
    encryption
    files
    fuse
    gateway
    interior
    pins
    libp2p
    merkledag
    nat
    releases
    repo
    routing
    tools
    tracking
    unix vs dag

Priority:
    P0 - Operations Functioning
    P1 - Operations Sort of Functioning
    P2 - Operations Not Functioning
    P3 - Operations Foobar (ciritical bug affecting master)
    P4 - Operations on Fire (critical bug affecting release)

Anything else need to be included?

chriscool · 2016-06-02T07:34:31Z

With PR #2790 the versions/platform/processor can be dealt with using ipfs version --all.

@em-ly I am not sure how it is possible, without being very verbose, to ask someone reporting an issue to select the Type, Area and Priority as per the above in a issue template.

Or do you mean that we should have something like:

Version/Platform/Processor information (from `ipfs version --all`):


Type (bug, feature, meta, test failure, question):
Area (api, commands, daemon, fuse, etc):
Priority (from P0: functioning, to P4: operations on fire):

Description:


---------------------------------------------------
Please read and then delete
This is for is for bug reports and directly actionable features only.
Check [where to report an issue](link) if that doesn't fit.
Check [how to report an issue](link) if you are not sure how to fill this issue.

and the "how to report an issue" linked document would show all the possible values for the Type, Area and Priority fields?

Kubuxu · 2016-06-02T08:15:38Z

@chriscool for me it looks great. Only think is that we don't (and shouldn't) use markdown formatting for links as people will see the template mostly in the raw form.

RichardLitt · 2016-06-02T08:25:58Z

ISSUE_TEMPLATE.md

+
+
+---------------------------------------------------
+Please read and then delete


"This is for you! Please read, and then delete this text before posting it."

RichardLitt · 2016-06-02T08:27:39Z

What about linking to support? What is ipfs/support for, then?

License: MIT Signed-off-by: Christian Couder <chriscool@tuxfamily.org>

chriscool · 2016-06-02T08:44:12Z

@RichardLitt @em-ly and @Kubuxu here is a new version that tries to take into account what you suggested.

Anyway before this can be merged we need at least the following:

improve https://github.com/ipfs/community/blob/master/contributing.md#reporting-issues so that it shows where different kinds of problem should be reported,
write https://github.com/ipfs/go-ipfs/blob/master/contribute.md#how-to-report-an-issue or something like that with all the options and their meaning @em-ly posted above,
merge PR Add version --all option #2790 to get ipfs version --all.

And yeah perhaps we could also add a link to ipfs/support too.

RichardLitt · 2016-06-02T08:57:14Z

Made this: ipfs/community#128

Agreed about making a "How to report an issue" for go-ipfs specifically. Happy to do that.

whyrusleeping · 2016-06-02T22:53:16Z

The information should be best effort by the user, we can correct and fill stuff in post-filing as we see fit

chriscool · 2016-06-03T07:01:32Z

@RichardLitt thanks for ipfs/community#128!
And yeah, it looks like the only thing left before we can merge this is making a "How to report an issue" for go-ipfs specifically using what @em-ly posted above. Thanks!

RichardLitt · 2016-06-04T13:49:55Z

I'm off hiking for a week, but happy to do this when I get back.

RichardLitt · 2016-06-13T11:56:02Z

And back. Will be addressing this this week.

whyrusleeping · 2016-06-21T16:57:03Z

@RichardLitt @em-ly update here?

em-ly · 2016-06-22T04:10:05Z

@RichardLitt is going to work on getting this completed for this week!
Thanks for bumping the issue.

On Tue, Jun 21, 2016 at 12:57 PM, Jeromy Johnson notifications@github.com
wrote:

@RichardLitt https://github.com/RichardLitt @em-ly
https://github.com/em-ly update here?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#2786 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/ASplmmRBWMdCcvLhZRDSDLqFO6B-l_s3ks5qOBflgaJpZM4Ir26U
.

Emily Moore
Project Manager
Protocol Labs, Inc.

See #2786 License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>

RichardLitt · 2016-06-22T15:10:32Z

Created #2889. This should be good to go, now?

chriscool · 2016-06-22T15:20:02Z

Yeah, when PR #2889 is merged, I will update this and it should be good to go.

Kubuxu · 2016-06-22T18:41:38Z

I would do something like:

Version information:

please run and copy here the result of: ipfs version -all

See #2786 License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>

whyrusleeping · 2016-06-22T19:28:32Z

#2889 is merged!

RichardLitt · 2016-06-22T21:40:21Z

LGTM. Let's try it!

whyrusleeping · 2016-06-23T00:27:15Z

is this RFM?

em-ly · 2016-06-23T00:50:03Z

LGTM! Thanks for all the work on this @chriscool @RichardLitt and @Kubuxu! Let's roll this out and test it throughout the week, edits made as necessary.

whyrusleeping · 2016-08-04T00:23:19Z

Feedback time, I think we need to use something much more minimal, there is too much text in the template and its a bit overwhelming to users who most of the time won't have any idea what half of it means. I propose something closer to:

[//]: # (Output From `ipfs version --all`)
- Version Information: 

[//]: # ( Bug, Feature, Enhancement, Etc )
- Type:

[//]: # ( from `P0` "Critical" to `P5` "Relatively Unimportant")
- Priority :

### Description:

Using a bit of a hack for markdown comments that the user will see when creating the issue, but that wont render when the issue itself is viewed.

RichardLitt · 2016-08-04T02:34:11Z

Looks very good to me!

dignifiedquire · 2016-08-04T08:40:09Z

I just discovered you can use html comments in these, take a look at the template from nodejs/node: https://raw.githubusercontent.com/nodejs/node/master/.github/ISSUE_TEMPLATE.md

These templates also seem to be quite useful and working

whyrusleeping · 2016-08-04T10:30:50Z

@dignifiedquire oooooh, good find! I like that a little better than the empty link hovertext hack i'm using

RichardLitt · 2016-08-04T18:56:17Z

Also worth taking into account: the repos in this repository: https://github.com/devspace/awesome-github-templates

jbenet · 2016-08-27T10:04:29Z

The current issue template is a bit cumbersome. maybe it's just how the formatting works. consider these that @RichardLitt posted: https://github.com/devspace/awesome-github-templates and how they do it. headings may be a good way to ask questions

chriscool force-pushed the issue-template branch from f52f36d to a063c9e Compare June 1, 2016 18:47

chriscool force-pushed the issue-template branch from a063c9e to 8f3e8a8 Compare June 1, 2016 19:03

chriscool force-pushed the issue-template branch from 8f3e8a8 to 15c7150 Compare June 1, 2016 19:25

chriscool force-pushed the issue-template branch from 15c7150 to ef2d12b Compare June 1, 2016 19:47

chriscool mentioned this pull request Jun 1, 2016

Add ipfs version --all to report all version information at once #2789

Closed

whyrusleeping reviewed Jun 1, 2016
View reviewed changes

RichardLitt reviewed Jun 2, 2016
View reviewed changes

Add ISSUE_TEMPLATE.md

5dbe772

License: MIT Signed-off-by: Christian Couder <chriscool@tuxfamily.org>

chriscool force-pushed the issue-template branch from ef2d12b to 5dbe772 Compare June 2, 2016 08:37

Kubuxu added the topic/meta Topic meta label Jun 13, 2016

whyrusleeping mentioned this pull request Jun 13, 2016

captain.log - go-ipfs #2247

Closed

RichardLitt mentioned this pull request Jun 20, 2016

Sprint: June 20 → July 3 ipfs/team-mgmt#114

Closed

whyrusleeping added this to the Ipfs 0.4.3 milestone Jun 21, 2016

RichardLitt added a commit that referenced this pull request Jun 22, 2016

Added a How To File GitHub Issues guide

d8109b6

See #2786 License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>

RichardLitt mentioned this pull request Jun 22, 2016

Added a How To File GitHub Issues guide #2889

Merged

RichardLitt added the need/review Needs a review label Jun 22, 2016

RichardLitt added a commit that referenced this pull request Jun 22, 2016

Added a How To File GitHub Issues guide

d785b4e

See #2786 License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>

RichardLitt added a commit that referenced this pull request Jun 22, 2016

Added a How To File GitHub Issues guide

e253190

See #2786 License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>

RichardLitt added a commit that referenced this pull request Jun 22, 2016

Added a How To File GitHub Issues guide

715b614

See #2786 License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>

whyrusleeping merged commit 0ac81da into master Jun 23, 2016

whyrusleeping deleted the issue-template branch June 23, 2016 00:56

whyrusleeping mentioned this pull request Aug 26, 2016

Edit issue reporting guides #3006

Merged



		---------------------------------------------------
		Please read and then delete

Add ISSUE_TEMPLATE.md #2786

Add ISSUE_TEMPLATE.md #2786

Conversation

chriscool commented Jun 1, 2016

Kubuxu commented Jun 1, 2016

chriscool commented Jun 1, 2016

Kubuxu commented Jun 1, 2016

chriscool commented Jun 1, 2016

Kubuxu commented Jun 1, 2016

chriscool commented Jun 1, 2016

Kubuxu commented Jun 1, 2016

whyrusleeping Jun 1, 2016

Choose a reason for hiding this comment

whyrusleeping commented Jun 1, 2016

em-ly commented Jun 1, 2016

chriscool commented Jun 2, 2016

Kubuxu commented Jun 2, 2016

RichardLitt Jun 2, 2016

Choose a reason for hiding this comment

RichardLitt commented Jun 2, 2016

chriscool commented Jun 2, 2016 • edited Loading

RichardLitt commented Jun 2, 2016

whyrusleeping commented Jun 2, 2016

chriscool commented Jun 3, 2016

RichardLitt commented Jun 4, 2016

RichardLitt commented Jun 13, 2016

whyrusleeping commented Jun 21, 2016

em-ly commented Jun 22, 2016

RichardLitt commented Jun 22, 2016

chriscool commented Jun 22, 2016

Kubuxu commented Jun 22, 2016

whyrusleeping commented Jun 22, 2016

RichardLitt commented Jun 22, 2016

whyrusleeping commented Jun 23, 2016

em-ly commented Jun 23, 2016

whyrusleeping commented Aug 4, 2016

RichardLitt commented Aug 4, 2016 • edited Loading

dignifiedquire commented Aug 4, 2016

whyrusleeping commented Aug 4, 2016

RichardLitt commented Aug 4, 2016

jbenet commented Aug 27, 2016 • edited Loading

chriscool commented Jun 2, 2016 •

edited

Loading

RichardLitt commented Aug 4, 2016 •

edited

Loading

jbenet commented Aug 27, 2016 •

edited

Loading