diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 9 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 3 | ||||
| -rw-r--r-- | .github/README.md | 19 |
3 files changed, 18 insertions, 13 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 49e2b90b..3a589484 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,13 +2,20 @@ 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 (run man tmux). +- 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) file. - Nobody else has opened the same issue recently. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index ee457237..8bf1e66a 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,6 +3,9 @@ Please read https://github.com/tmux/tmux/blob/master/.github/CONTRIBUTING.md before opening an issue. +If you have upgraded, make sure your issue is not covered in the CHANGES file +for your version: https://raw.githubusercontent.com/tmux/tmux/master/CHANGES + Describe the problem and the steps to reproduce. Add a minimal tmux config if necessary. Screenshots can be helpful, but no more than one or two. diff --git a/.github/README.md b/.github/README.md index 6e262ef5..2b299cc5 100644 --- a/.github/README.md +++ b/.github/README.md @@ -30,7 +30,8 @@ configure with `--enable-utempter` to enable this. ### From version control -To get and build the latest from version control: +To get and build the latest from version control - note that this requires +`autoconf`, `automake` and `pkg-config`: ~~~bash git clone https://github.com/tmux/tmux.git @@ -39,10 +40,6 @@ sh autogen.sh ./configure && make ~~~ -(Note that this requires at least a working C compiler, `make`, `autoconf`, -`automake`, `pkg-config` as well as `libevent` and `ncurses` libraries and -headers.) - ## Contributing Bug reports, feature suggestions and especially code contributions are most @@ -50,14 +47,12 @@ welcome. Please send by email to: tmux-users@googlegroups.com -Or open a GitHub issue or pull request. - -There is [a TODO list](https://github.com/tmux/tmux/wiki/Contributing) which -explains some ideas for tmux not yet developed. Please feel free to ask for -clarifications on the mailing list if you're thinking of working on these or -need further information. +Or open a GitHub issue or pull request. **Please read [this +document](CONTRIBUTING.md) before opening an issue.** -Please read the CONTRIBUTING file before opening an issue. +There is [a list of suggestions for contributions](https://github.com/tmux/tmux/wiki/Contributing). +Please feel free to ask on the mailing list if you're thinking of working on something or need +further information. ## Documentation |