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

Issue Reporting Guide #1946

Closed
RichardLitt opened this issue Nov 6, 2015 · 4 comments
Closed

Issue Reporting Guide #1946

RichardLitt opened this issue Nov 6, 2015 · 4 comments
Labels
need/community-input Needs input from the wider community topic/docs-ipfs Topic docs-ipfs

Comments

@RichardLitt
Copy link
Member

@whyrusleeping raised a good point about possibly adding an issue reporting guide for go-ipfs:

Maybe we should also add an 'issue reporting' guide, and mention ipfs diag sys and that providing a shell script or set of commands to repro the issue is recommended.

What are some basic points you would like to see covered in issues, particularly of different types, for this repository? If someone submits an error, how would you like it to look? I'm not sure that this is written anywhere. I'm not suggesting a must-conform-to-guide, but a document that we can add either here or in ipfs/community that helps people who may not know how to file an appropriate issue for their system.

Speaking of which, @whyrusleeping, ipfs diag sys threw an error for me (Error: Unknown Command "sys").

@RichardLitt RichardLitt added topic/docs-ipfs Topic docs-ipfs need/community-input Needs input from the wider community labels Nov 6, 2015
@ghost
Copy link

ghost commented Nov 7, 2015

:5001/debug/pprof might be useful too

@rht
Copy link
Contributor

rht commented Nov 7, 2015

Guides to be derived from: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html (ref-ed in git), https://github.com/adobe/brackets/wiki/How-to-Report-an-Issue.

What about enabling anon bug report https://gitreports.com/?

@jbenet
Copy link
Member

jbenet commented Dec 2, 2015

definitely ok with anon bug reports, but it's also trivial to create an account and having conversations over issues is very nice/useful.

@michaelavila
Copy link
Contributor

Closing as I see much of this information in the issue template when creating a new issue: https://github.com/ipfs/go-ipfs/issues/new

Please re-open if I've misunderstood.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/community-input Needs input from the wider community topic/docs-ipfs Topic docs-ipfs
Projects
None yet
Development

No branches or pull requests

4 participants