Added a How To File GitHub Issues guide
See https://github.com/ipfs/go-ipfs/pull/2786 License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Jun 19, 2016 at 15:18 UTC
715b6145bb7471ce90e6023a1360290f3cc30caf
1 file changed
+79
docs/github-issue-guide.md
new
+79
@@ -0,0 +1,79 @@
1
+# How to file a GitHub Issue
2
+
3
+We use GitHub Issues to log all of our todos and tasks. Here is [a good guide](https://guides.github.com/features/issues/) for them if you are unfamiliar.
4
+
5
+When logging an issue with go-ipfs, it would be useful if you specified the below information, if possible. This will help us triage the issues faster. Please title your issues with the type. For instance:
6
+
7
+- "bug: Cannot add file with `ipfs add`"
8
+- "question: How do I use `ipfs block <hash>`?"
9
+
10
+Putting the command in backticks helps us parse the natural language description, and is generally suggested.
11
+
12
+This is a _living guide_. If you see anything that should be here and isn't, or have ideas on improvement, please open a "meta" issue.
13
+
14
+### Type
15
+
16
+- "bug": If what you are filing is a bug.
17
+- "meta": If it is something about how we run go-ipfs, and not code related in itself.
18
+- "question": If you have a question.
19
+- "test failure": If the tests are failing
20
+- "panic": If it is a severe bug.
21
+- "enhancement ": If you have a feature you would like that enhances go-ipfs.
22
+
23
+### Platform
24
+
25
+For platform and processor, just run `ipfs version --all` and include that output.
26
+
27
+Your platform.
28
+
29
+- "Linux"
30
+- "Windows"
31
+- "Mac"
32
+- Etc.
33
+
34
+### Processor
35
+
36
+Your processor.
37
+
38
+- "x86"
39
+- "amd64"
40
+- "Arm"
41
+
42
+### Area
43
+
44
+What your issue refers to. Multiple items are OK.
45
+
46
+- "api"
47
+- "bandwidth reduction"
48
+- "bit swap"
49
+- "blockstore"
50
+- "commands"
51
+- "containers + vms"
52
+- "core"
53
+- "daemon + init"
54
+- "dat"
55
+- "discovery"
56
+- "encryption"
57
+- "files"
58
+- "fuse"
59
+- "gateway"
60
+- "gx"
61
+- "interior"
62
+- "pins"
63
+- "libp2p"
64
+- "merkledag"
65
+- "nat"
66
+- "releases"
67
+- "repo"
68
+- "routing"
69
+- "tools"
70
+- "tracking"
71
+- "unix vs dag"
72
+
73
+### Priority
74
+
75
+- "P0 - Operations Functioning"
76
+- "P1 - Operations Sort of Functioning"
77
+- "P2 - Operations Not Functioning"
78
+- "P3 - Operations Foobar (critical bug affecting master)"
79
+- "P4 - Operations on Fire (critical bug affecting release)"