diff --git a/documentation/github-issue-guide.md b/documentation/github-issue-guide.md new file mode 100644 index 00000000..dd41a6da --- /dev/null +++ b/documentation/github-issue-guide.md @@ -0,0 +1,62 @@ +# How to file a GitHub Issue + +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. + +When logging an issue with xdag, 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: + +- "bug: Cannot run xdag with `./xdag -d -m 2 pool.address:port`" +- "question: How do I use `./xdag block
`?" + +Putting the command in backticks helps us parse the natural language description, +and is generally suggested. + +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. + +### Type + +- "bug": If what you are filing is a bug. +- "meta": If it is something about how we run xdag, and not code related in itself. +- "question": If you have a question. +- "panic": If it is a severe bug. +- "enhancement ": If you have a feature you would like that enhances xdag. + +### Platform + +Your platform. + +- "Linux" +- "Windows" +- "Mac" +- Etc. + +### Processor + +Your processor architecture. + +- "x86" +- "amd64" +- "Arm" + +### Area + +What your issue refers to. Multiple items are OK. + +- "network" Network related issues. +- "rpc" RPC service related issues. +- "core" Core related issues. +- "releases" Build script, or build enviroment related issues. + +### Priority + +- Critical - System crash, application panic. +- High - The main functionality of the application does not work, API breakage, + repo format breakage, etc. +- Medium - A non-essential functionality does not work, performance issues, etc. +- Low - An optional functionality does not work. +- Very Low - Translation or documentation mistake. Something that really does + not matter much but should be noticed for a future release.