diff options
| author | Bruce A. Mah <bmah@es.net> | 2017-04-21 13:03:28 -0700 |
|---|---|---|
| committer | Bruce A. Mah <bmah@es.net> | 2017-04-21 13:03:28 -0700 |
| commit | 13ff67e5824828c917be95b83e8c96bc2ea72b19 (patch) | |
| tree | 27f65bfddd236802004952cb96f0fcb42f9c4951 /.github | |
| parent | b1bc12a209cd936c726e941660c3d61ca2b1efcc (diff) | |
| download | iperf3-13ff67e5824828c917be95b83e8c96bc2ea72b19.tar.gz | |
Tweaks to the GitHub templates, per discussion with @bltierney.
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 6 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 21 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 3 |
3 files changed, 24 insertions, 6 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 758089f..0b3eaf7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -20,12 +20,14 @@ have been asked (and maybe even answered) before. http://fasterdata.es.net/ has some information on the use of various bandwidth measurement tools, including iperf3. The iperf3 documentation Web site at http://software.es.net/iperf/ contains -various bits of helpful information, including an FAQ. +various bits of helpful information, including a list of +[frequently-asked questions](http://software.es.net/iperf/faq.html). We specifically discourage the use of the issue tracker on the iperf3 GitHub project page for asking questions. Questions posted in the form of issues may go unanswered. Please use a questions site -such as Stack Overflow to ask questions of the community or +such as [Stack Overflow](http://www.stackoverflow.com) +to ask questions of the community or alternatively use the iperf3 mailing list at iperf-dev@googlegroups.com (posting requires joining the list). diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d73a6e9..1a37a2c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -2,7 +2,9 @@ _NOTE: The iperf3 issue tracker is for registering bugs, enhancement requests, or submissions of code. It is not a means for asking questions about building or using iperf3. Those are best directed towards the iperf3 mailing list at iperf-dev@google-groups.com or -question sites such as Stack Overflow (http://www.stackoverflow.com/)._ +question sites such as Stack Overflow +(http://www.stackoverflow.com/). A list of frequently-asked questions +regarding iperf3 can be found at http://software.es.net/iperf/faq.html._ # Context @@ -20,15 +22,28 @@ iperf3 on Windows, iOS, or Android._ * Other relevant information (for example, non-default compilers, libraries, cross-compiling, etc.): -# Behavior +_Please fill out one of the "Bug Report" or "Enhancement Request" +sections, as appropriate._ + +# Bug Report * Expected Behavior * Actual Behavior +* Steps to Reproduce + * Possible Solution _Please submit patches or code changes as a pull request._ -* Steps to Reproduce (in case of bugs) +# Enhancement Request + +* Current behavior + +* Desired behavior + +* Implementation notes +_If submitting a proposed implementation of an enhancement request, +please use the pull request mechanism._ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1588768..aeeb6c6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,7 +17,8 @@ such enhancements or derivative works thereof, in binary and source code form. _The complete iperf3 license is available in the `LICENSE` file in the top directory of the iperf3 source tree._ -* Version of iperf (or development branch, such as `master` or `3.1-STABLE`): +* Version of iperf3 (or development branch, such as `master` or + `3.1-STABLE`) to which this pull request applies: * Issues fixed (if any): |