summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md73
-rw-r--r--.github/ISSUE_TEMPLATE.md48
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md26
-rw-r--r--.github/workflows/test.yml35
4 files changed, 182 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..0227137
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,73 @@
+# iperf3 Contribution Guidelines
+
+Thanks for contributing to iperf3!
+
+This page contains some guidelines for filing issues, pull requests,
+and other sorts of interactions with the iperf3 project. These are
+guidelines and not hard rules, and it is intended that common sense
+and good judgement will prevail.
+
+## Support
+
+iperf3 is officially supported on Linux (various distributions),
+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 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 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).
+
+## Code
+
+If you have improvements or bugfixes to make to iperf3, we'd love to
+hear from you. We prefer changes to be submitted in the form of pull
+requests on GitHub, although we can (probably) accept simple patches
+as well. If in doubt, ask.
+
+Before making any submission to the iperf3 project (whether it be code
+or documentation), we urge you to consult the iperf3 license, in
+particular the section quoted below:
+
+```
+You are under no obligation whatsoever to provide any bug fixes, patches, or
+upgrades to the features, functionality or performance of the source code
+("Enhancements") to anyone; however, if you choose to make your Enhancements
+available either publicly, or directly to Lawrence Berkeley National
+Laboratory, without imposing a separate written license agreement for such
+Enhancements, then you hereby grant the following license: a non-exclusive,
+royalty-free perpetual license to install, use, modify, prepare derivative
+works, incorporate into other computer software, distribute, and sublicense
+such enhancements or derivative works thereof, in binary and source code form.
+```
+
+If you're considering changes that will have an architectural impact,
+we strongly encourage discussing them with the iperf3 maintainers
+before doing a significant amount of work on the code. We might be
+able to provide some guidance. Also, we're more likely to accept a
+submission if if it doesn't involve rewriting large sections of the
+code. Even if you're going to fork the code and maintain your own
+changes privately (which you're perfectly welcome to do) we might able
+to give you guidance so that future iperf3 changes won't conflict with
+your work.
+
+## Conduct
+
+We expect that iperf3 interactions via the issue tracker, mailing
+lists, and so forth will be conducted civilly. Language that is
+deemed appropriate or abusive may be removed, and we reserve the right
+to ban users from accessing the project for repeated offense.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..9c75869
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,48 @@
+_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 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
+
+* Version of iperf3:
+
+* Hardware:
+
+* Operating system (and distribution, if any):
+
+_Please note: iperf3 is supported on Linux, 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._
+
+* Other relevant information (for example, non-default compilers,
+ libraries, cross-compiling, etc.):
+
+_Please fill out one of the "Bug Report" or "Enhancement Request"
+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
+
+* Expected Behavior
+
+* Actual Behavior
+
+* Steps to Reproduce
+
+* Possible Solution
+
+# Enhancement Request
+
+* Current behavior
+
+* Desired behavior
+
+* Implementation notes
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..aeeb6c6
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,26 @@
+_PLEASE NOTE the following text from the iperf3 license. Submitting a
+pull request to the iperf3 repository constitutes "[making]
+Enhancements available...publicly":_
+
+```
+You are under no obligation whatsoever to provide any bug fixes, patches, or
+upgrades to the features, functionality or performance of the source code
+("Enhancements") to anyone; however, if you choose to make your Enhancements
+available either publicly, or directly to Lawrence Berkeley National
+Laboratory, without imposing a separate written license agreement for such
+Enhancements, then you hereby grant the following license: a non-exclusive,
+royalty-free perpetual license to install, use, modify, prepare derivative
+works, incorporate into other computer software, distribute, and sublicense
+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 iperf3 (or development branch, such as `master` or
+ `3.1-STABLE`) to which this pull request applies:
+
+* Issues fixed (if any):
+
+* Brief description of code changes (suitable for use as a commit message):
+
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..afc960d
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,35 @@
+name: test
+on: [push, pull_request]
+jobs:
+ cppcheck-test:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - name: install dependencies
+ run: |
+ sudo apt-get -y update && sudo apt-get install -y cppcheck && \
+ cppcheck . --force --inline-suppr
+ build-test-latest:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - name: install dependencies
+ run: |
+ sudo apt-get -y update && sudo apt-get install -y build-essential
+ - name: build
+ run: |
+ ./configure && make && make check
+ timeout 300 src/iperf3 -s &
+ ./test_commands.sh localhost
+ build-test-ubuntu-20_04:
+ runs-on: ubuntu-20.04
+ steps:
+ - uses: actions/checkout@v3
+ - name: install dependencies
+ run: |
+ sudo apt-get -y update && sudo apt-get install -y build-essential
+ - name: build
+ run: |
+ ./configure && make && make check
+ timeout 300 src/iperf3 -s &
+ ./test_commands.sh localhost