.config/awesome/ISSUE_TEMPLATE.md

   1 # Please, read me!
   2
   3 So that I can help you quickly and without having to redirect you here.
   4
   5 # If you have a question
   6
   7 Take the following steps:
   8
   9 1. Use a web search engine
  10 2. Search in [Awesome doc](https://awesomewm.org/doc)
  11 3. Ask the [community](https://awesomewm.org/community)
  12
  13 and, if you still don't have an answer, you can ask here.
  14
  15 **Please be warned:** if your question is unrelated to this repository, a reply is only an act of kindness.
  16
  17 # If you have an issue <a name="issuesec"/>
  18
  19 First do
  20
  21 1. search the [issues section](https://github.com/lcpz/awesome-copycats/issues) and
  22 2. search [lain issues section](https://github.com/lcpz/lain/issues) and
  23 3. search [lain wiki](https://github.com/lcpz/lain/wiki) and
  24 4. try with default Awesome configuration, usually located in `/etc/xdg/awesome/rc.lua` or `/usr/local/etc/xdg/awesome/rc.lua`.
  25
  26 If you can't find a solution and your issue doesn't happen with default configuration, then go ahead and provide:
  27
  28 * output of `awesome -v` and `lua -v`
  29 * expected behavior and actual behavior
  30 * steps to reproduce the problem
  31 * X error log (if needed)
  32
  33 # If Awesome fails to start
  34
  35 Then something went wrong during its initialisation. You have to provide X error
  36 log. There are two ways:
  37
  38 1. Restart X like this:
  39   ```shell
  40   startx -- -keeptty -nolisten tcp > $HOME/.xorg.log 2>&1
  41   ```
  42   the error log will be output into `$HOME/.xorg.log`.
  43
  44 2. Use [Xephyr](https://wikipedia.org/wiki/Xephyr):
  45   ```shell
  46   # set screen size as you like
  47   Xephyr :1 -screen 1280x800 2> stdout.txt & DISPLAY=:1 awesome
  48   ```
  49   the error log will be output into the file `stdout.txt`.
  50
  51 Before reporting, read the log and see if you can solve it yourself. If you can't, then follow the [previous section](#issuesec).
  52
  53 # If you have a new feature or theme request
  54
  55 Write a detailed description of the desired design, preferably with screenshots or mockups.