From 4aa5dd0ee0bef7a6dfeb0b3329d78660ae197201 Mon Sep 17 00:00:00 2001 From: Nicholas Marriott Date: Thu, 27 Oct 2016 18:28:21 +0100 Subject: Add a CONTRIBUTING file with some information on opening issues. --- CONTRIBUTING | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING (limited to 'CONTRIBUTING') diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 00000000..e355c1b4 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,25 @@ +When reporting issues: + +YOU MUST INCLUDE THE TMUX VERSION + +DO NOT OPEN AN ISSUE THAT DOES NOT MENTION THE TMUX VERSION + +Please also include: + +- your platform (Linux, OS X, 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); +- at most one or two screenshots, if helpful. + +Please do not report bugs (crashes, incorrect behaviour) without reproducing on +a tmux built from Git master. + +To run tmux without a config and get logs, run: + + tmux -Ltest kill-server + tmux -vvvv -Ltest -f/dev/null new + +Then reproduce the problem, exit tmux, and attach the tmux-server-*.log file +from the current directory to the issue. -- cgit