@cryptotaxi247 / kubo / commits / ab3344519

merge github-issue-guide with the issue template

License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>

Steven Allen committed Jan 31, 2018 at 17:01 UTC ab33445190c3fac5f7f639c1f7e0f256c506cc1e
2 files changed +22 -90
ISSUE_TEMPLATE.md
+22 -3
@@ -1,14 +1,33 @@
1 <!-- 🔥❓If you have a *QUESTION* about IPFS, please ask on our forum at https://discuss.ipfs.io 🔥❓
2
3 -The go-ipfs issues are *only* for bug reports and directly actionable feature requests. Please direct all other questions, ideas, or suggestions to our discuss forum. Remember to search the issue tracker for an existing report concerning your issue before posting, and see https://github.com/ipfs/go-ipfs/blob/master/docs/github-issue-guide.md if you are not sure how to fill in this issue. -->
3 +If you haven't yet searched the issue tracker for an existing report concerning your issue, please do so now.
4 +
5 +The go-ipfs issues are *only* for bug reports and directly actionable feature requests. Read https://github.com/ipfs/community/blob/master/contributing.md#reporting-issues if your issue doesn't fit either of those categories.
6 +
7 +* If you have a *SUPPORT QUESTION*, please direct it to our forum at https://discuss.ipfs.io.
8 +* If you want to discuss a design idea related to ipfs but not directly related to the go implementation, please file an issue at https://github.com/ipfs/ipfs.
9 +-->
10
11 #### Version information:
12 <!-- Output From `ipfs version --all`
13
8 -Please check dist.ipfs.io for a newer version of go-ipfs and update if necessary. Report back if the problem persists. -->
14 +Please check dist.ipfs.io for a newer version of go-ipfs and update if necessary. Report back if the problem persists.
15 +
16 +If you can't run `ipfs version --all` or that command fails, include as much information as you can: IPFS version, computer architecture (e.g., Intel x86 64bit), operating system, etc. -->
17
18 #### Type:
11 -<!-- Bug, Feature, Enhancement, Etc -->
19 +<!--
20 +
21 +- "bug": If what you are filing is a bug.
22 +- "feature": If you'd like to suggest a feature.
23 +- "enhancement ": If you'd like to suggest an improvement on to existing feature.
24 +- "test failure": If the tests are failing
25 +- "doc": If it's related to missing/incorrect documentation.
26 +- "meta": If its a meta issue about this project/this repository/issue tracker.
27 +
28 +Feel free to choose your own category if none of these fit your needs. However, be careful, that may indicate that your issue doesn't belong in this repo.
29 +
30 +-->
31
32 #### Description:
33 <!-- This is where you get to tell us what went wrong or your specific feature request. When doing so, please make sure to include *all* relevant information.
docs/github-issue-guide.md deleted
-87
@@ -1,87 +0,0 @@
1 -# How to file a GitHub Issue
2 -
3 -We use GitHub Issues to log all of our todos and tasks. Here is
4 -[a good guide](https://guides.github.com/features/issues/) for them if you are
5 -unfamiliar.
6 -
7 -When logging an issue with go-ipfs, it would be useful if you specified the
8 -below information, if possible. This will help us triage the issues faster.
9 -Please title your issues with the type. For instance:
10 -
11 -- "bug: Cannot add file with `ipfs add`"
12 -- "question: How do I use `ipfs block <hash>`?"
13 -
14 -Putting the command in backticks helps us parse the natural language description,
15 -and is generally suggested.
16 -
17 -This is a _living guide_. If you see anything that should be here and isn't, or
18 -have ideas on improvement, please open a "meta" issue.
19 -
20 -### Type
21 -
22 -- "bug": If what you are filing is a bug.
23 -- "meta": If it is something about how we run go-ipfs, and not code related in itself.
24 -- "question": If you have a question.
25 -- "test failure": If the tests are failing
26 -- "panic": If it is a severe bug.
27 -- "enhancement ": If you have a feature you would like that enhances go-ipfs.
28 -
29 -### Platform
30 -
31 -For platform and processor, just run `ipfs version --all` and include that output.
32 -
33 -Your platform.
34 -
35 -- "Linux"
36 -- "Windows"
37 -- "Mac"
38 -- Etc.
39 -
40 -### Processor
41 -
42 -Your processor architecture.
43 -
44 -- "x86"
45 -- "amd64"
46 -- "Arm"
47 -
48 -### Area
49 -
50 -What your issue refers to. Multiple items are OK.
51 -
52 -- "api"
53 -- "bandwidth reduction"
54 -- "bit swap"
55 -- "blockstore"
56 -- "commands"
57 -- "containers + vms"
58 -- "core"
59 -- "daemon + init"
60 -- "dat"
61 -- "discovery"
62 -- "encryption"
63 -- "files"
64 -- "fuse"
65 -- "gateway"
66 -- "gx"
67 -- "interior"
68 -- "pins"
69 -- "libp2p"
70 -- "merkledag"
71 -- "nat"
72 -- "releases"
73 -- "repo"
74 -- "routing"
75 -- "tools"
76 -- "tracking"
77 -- "unix vs dag"
78 -
79 -### Priority
80 -
81 -- Critical - System crash, application panic.
82 -- High - The main functionality of the application does not work, API breakage,
83 - repo format breakage, etc.
84 -- Medium - A non-essential functionality does not work, performance issues, etc.
85 -- Low - An optional functionality does not work.
86 -- Very Low - Translation or documentation mistake. Something that really does
87 - not matter much but should be noticed for a future release.