Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update templates and (some) documentation for discussions #1232

Merged
merged 2 commits into from
Nov 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,20 @@ FreeBSD, and macOS. Support may be provided on a best-effort basis to
other UNIX-like platforms. We cannot provide support for building
and/or running iperf3 on Windows, iOS, or Android.

Before asking for help, please use your favorite search engine or
questions site (such as Stack Overflow) to see if your question might
have been asked (and maybe even answered) before.
https://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 a list of
Before asking for help, please check with your favorite search engine
or the
[iperf3 Discussions site on GitHub](http://github.com/esnet/iperf/discussions)
to see if your question might have been asked (and maybe even
answered) before. https://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 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](http://www.stackoverflow.com)
form of issues may go unanswered. Please use the
[iperf3 Discussions site on GitHub](http://github.com/esnet/iperf/discussions)
to ask questions of the community or
alternatively use the iperf3 mailing list at
iperf-dev@googlegroups.com (posting requires joining the list).
Expand Down
15 changes: 7 additions & 8 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
_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@googlegroups.com or
question sites such as Stack Overflow
(http://www.stackoverflow.com/). A list of frequently-asked questions
towards the Discussions section for this project at
https://github.com/esnet/iperf/discussions
or to the iperf3 mailing list at iperf-dev@googlegroups.com.
A list of frequently-asked questions
regarding iperf3 can be found at http://software.es.net/iperf/faq.html._

# Context
Expand All @@ -23,7 +24,9 @@ iperf3 on Windows, iOS, or Android._
libraries, cross-compiling, etc.):

_Please fill out one of the "Bug Report" or "Enhancement Request"
sections, as appropriate._
sections, as appropriate. Note that submissions of bug fixes, new
features, etc. should be done as a pull request at
https://github.com/esnet/iperf/pulls_

# Bug Report

Expand All @@ -35,8 +38,6 @@ sections, as appropriate._

* Possible Solution

_Please submit patches or code changes as a pull request._

# Enhancement Request

* Current behavior
Expand All @@ -45,5 +46,3 @@ _Please submit patches or code changes as a pull request._

* Implementation notes

_If submitting a proposed implementation of an enhancement request,
please use the pull request mechanism._
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ For more information see: https://software.es.net/iperf

Source code and issue tracker: https://github.com/esnet/iperf

Discussion forums: https://github.com/esnet/iperf/discussions

Obtaining iperf3
----------------

Expand Down