summaryrefslogtreecommitdiffstats
path: root/.github/CONTRIBUTING.md
blob: 0c517a52b908dcd0d7a8f272f623618c4e7ef6fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
## What should I do before opening an issue?

Before opening an issue, please ensure that:

- Your problem is a specific problem or question or suggestion, not a general
  complaint.

- `$TERM` inside tmux is screen, screen-256color, tmux or tmux-256color. Check
  by running `echo $TERM` inside tmux.

- You can reproduce the problem with the latest tmux release, or a build from
  Git master.

- Your question or issue is not covered [in the
  manual](https://man.openbsd.org/tmux.1) (run `man tmux`).

- Your problem is not mentioned in [the CHANGES
  file](https://raw.githubusercontent.com/tmux/tmux/master/CHANGES).

- Nobody else has opened the same issue recently.

## What should I include in an issue?

Please include the output of:

~~~bash
uname -sp && tmux -V && echo $TERM
~~~

Also include:

- Your platform (Linux, macOS, or whatever).

- A brief description of the problem with steps to reproduce.

- A minimal tmux config, if you can't reproduce without a config.

- Your terminal, and `$TERM` inside and outside of tmux.

- Logs from tmux (see below). Please attach logs to the issue directly rather
  than using a download site or pastebin. Put in a zip file if necessary.

- At most one or two screenshots, if helpful.

## How do I test without a .tmux.conf?

Run a separate tmux server with `-f/dev/null` to skip loading `.tmux.conf`:

~~~bash
tmux -Ltest kill-server
tmux -Ltest -f/dev/null new
~~~

## How do I get logs from tmux?

Add `-vv` to tmux to create three log files in the current directory. If you can
reproduce without a configuration file:

~~~bash
tmux -Ltest kill-server
tmux -vv -Ltest -f/dev/null new
~~~

Or if you need your configuration:

~~~base
tmux kill-server
tmux -vv new
~~~

The log files are:

- `tmux-server*.log`: server log file.

- `tmux-client*.log`: client log file.

- `tmux-out*.log`: output log file.

Please attach the log files to your issue.