Skip to content

Commit

Permalink
Update issue template based on ckb-dev-detect
Browse files Browse the repository at this point in the history
  • Loading branch information
Oleksii Vilchanskyi committed Jun 19, 2017
1 parent 4605daa commit faf7c2c
Showing 1 changed file with 34 additions and 42 deletions.
76 changes: 34 additions & 42 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
Switch on the "Preview" mode for better reading experience.
__Switch on the "Preview" mode for better reading experience.__
Use it to put ticks and then switch back to write in the details where needed.

<!-- TOC -->

- [Before you proceed](#before-you-proceed)
- [Devices](#devices)
- [Keyboard](#keyboard)
- [Mouse](#mouse)
- [Devices information](#devices-information)
- [New device support request](#new-device-support-request)
- [Feature request](#feature-request)
- [What is the program's current behavior?](#what-is-the-programs-current-behavior)
Expand All @@ -15,7 +13,6 @@ Use it to put ticks and then switch back to write in the details where needed.
- [Bug report](#bug-report)
- [General information](#general-information)
- [Source](#source)
- [Version](#version)
- [Branch](#branch)
- [Logs & crash reports](#logs--crash-reports)
- [What is the program's current behavior?](#what-is-the-programs-current-behavior-1)
Expand All @@ -29,7 +26,7 @@ Use it to put ticks and then switch back to write in the details where needed.

# Before you proceed

- [ ] __Try__ the latest code from the [`testing` branch](https://github.com/mattanger/ckb-next/tree/testing).
- [ ] __Try__ the latest code by cloning and building the project manually.
- [ ] __Read__ the [`README.md`](https://github.com/mattanger/ckb-next/blob/master/README.md) _in full_.
- [ ] __Skim__ through other `.md` documents in the project's root. They contain more specific information.
- [ ] __Search__ in open _and_ closed [Issues](https://github.com/mattanger/ckb-next/issues). [Here's how](https://help.github.com/articles/searching-issues/).
Expand All @@ -41,38 +38,36 @@ Now, __before you proceed even further__, make sure you are following the recomm

---

# Devices
# Devices information

## Keyboard
Run [`ckb-dev-detect`](https://github.com/mattanger/ckb-next/blob/master/ckb-dev-detect) from the root of the source code tree:

<sub><sup>leave empty if you have no keyboard</sup></sub>
```console
$ ./ckb-dev-detect
```

* _full name_:
- [ ] RGB
- [ ] non-RGB

## Mouse

<sub><sup>leave empty if you have no mouse</sup></sub>

* _full name_:
- [ ] RGB
- [ ] non-RGB
Upload `ckb-dev-detect-report.gz` on GitHub with this issue.

---

# New device support request

<sub><sup>leave empty if you have no new device support requests</sup></sub>
- [ ] Yes
- [ ] No

- [ ] __Linux__: upload the output of `ckb-dev-detect` shell script located at the root of the ckb-next source tree
<sub><sup>leave empty if you have no new device support requests</sup></sub>

- [ ] __macOS__: upload a full dump following [the instructions](https://github.com/mattanger/ckb-next/issues/31#issuecomment-285380447)
You should upload:
* __Linux__: `ckb-dev-detect-report.gz` is enough
* __macOS__: a full dump following [the instructions](https://github.com/mattanger/ckb-next/issues/31#issuecomment-285380447)

---

# Feature request

- [ ] Yes
- [ ] No

<sub><sup>leave empty if you have no feature requests</sup></sub>

## What is the program's current behavior?
Expand All @@ -85,38 +80,35 @@ Now, __before you proceed even further__, make sure you are following the recomm

# Bug report

<sub><sup>leave empty if you have no bug reports</sup></sub>

- [ ] __Linux__:
* _distribution's name_:
* _distribution's version_ (pass if rolling):
* _output_ of `uname -r`:
- [ ] Yes
- [ ] No

- [ ] __macOS__:
* _OS version_:
<sub><sup>leave empty if you have no bug reports</sup></sub>

## General information

### Source
(how and where did you get this program, e.g.: _"`ckb-next-git` package in AUR"_ or _"built manually using quickinstall script"_ or _"pkg for macOS"_)

### Version
(ckb-next's version which can be found in the "Settings" tab in the GUI, e.g.: _"ckb-next beta-v0.2.7"_)

### Branch
(fill in if ckb-next was compiled manually, e.g.: _"master"_ or _"testing"_)
(fill in if ckb-next was compiled manually, e.g.: _"master"_ or _"newdev"_)

## Logs & crash reports
(any useful information - an OS crash report, debugger's backtrace, any non-standard way of usage (BIOS mode ...) etc.)

You should upload:

- [ ] Linux:
* a journal log gathered by your init system (`journalctl(1)` etc.) Look for __usb__, __ckb__, __ckb-daemon__ and provide a meaningful context
* the output of `ckb-daemon`: `systemctl status ckb-daemon`

- [ ] macOS:
* the output of `ckb-daemon`: `sudo launchctl unload /Library/LaunchDaemons/com.ckb.daemon.plist && sudo /Applications/ckb.app/Contents/Resources/ckb-daemon`
- Linux: `ckb-dev-detect-report.gz` is enough
- macOS:
* the output of `ckb-daemon`:
```console
$ sudo launchctl unload /Library/LaunchDaemons/com.ckb.daemon.plist
$ sudo /Applications/ckb.app/Contents/Resources/ckb-daemon
```
* the output of `ckb` (open another terminal):
```console
$ sudo killall -9 ckb
$ /Applications/ckb.app/Contents/MacOS/ckb
```

## What is the program's current behavior?

Expand Down

0 comments on commit faf7c2c

Please sign in to comment.