.github/CONTRIBUTING.md

   1 ## What should I do before opening an issue?
   2
   3 Before opening an issue, please ensure that:
   4
   5 - Your problem is a specific problem or question or suggestion, not a general
   6   complaint.
   7
   8 - `$TERM` inside tmux is screen, screen-256color, tmux or tmux-256color. Check
   9   by running `echo $TERM` inside tmux.
  10
  11 - You can reproduce the problem with the latest tmux release, or a build from
  12   Git master.
  13
  14 - Your question or issue is not covered [in the
  15   manual](https://man.openbsd.org/tmux.1) (run `man tmux`).
  16
  17 - Your problem is not mentioned in [the CHANGES
  18   file](https://raw.githubusercontent.com/tmux/tmux/master/CHANGES).
  19
  20 - Nobody else has opened the same issue recently.
  21
  22 ## What should I include in an issue?
  23
  24 Please include the output of:
  25
  26 ~~~bash
  27 uname -sp && tmux -V && echo $TERM
  28 ~~~
  29
  30 Also include:
  31
  32 - Your platform (Linux, macOS, or whatever).
  33
  34 - A brief description of the problem with steps to reproduce.
  35
  36 - A minimal tmux config, if you can't reproduce without a config.
  37
  38 - Your terminal, and `$TERM` inside and outside of tmux.
  39
  40 - Logs from tmux (see below). Please attach logs to the issue directly rather
  41   than using a download site or pastebin. Put in a zip file if necessary.
  42
  43 - At most one or two screenshots, if helpful.
  44
  45 ## How do I test without a .tmux.conf?
  46
  47 Run a separate tmux server with `-f/dev/null` to skip loading `.tmux.conf`:
  48
  49 ~~~bash
  50 tmux -Ltest kill-server
  51 tmux -Ltest -f/dev/null new
  52 ~~~
  53
  54 ## How do I get logs from tmux?
  55
  56 Add `-vv` to tmux to create three log files in the current directory. If you can
  57 reproduce without a configuration file:
  58
  59 ~~~bash
  60 tmux -Ltest kill-server
  61 tmux -vv -Ltest -f/dev/null new
  62 ~~~
  63
  64 Or if you need your configuration:
  65
  66 ~~~base
  67 tmux kill-server
  68 tmux -vv new
  69 ~~~
  70
  71 The log files are:
  72
  73 - `tmux-server*.log`: server log file.
  74
  75 - `tmux-client*.log`: client log file.
  76
  77 - `tmux-out*.log`: output log file.
  78
  79 Please attach the log files to your issue.