Return to CONTRIBUTING.md CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / iperf / .github

iperf 3.3.9

    1: # iperf3 Contribution Guidelines
    2: 
    3: Thanks for contributing to iperf3!
    4: 
    5: This page contains some guidelines for filing issues, pull requests,
    6: and other sorts of interactions with the iperf3 project.  These are
    7: guidelines and not hard rules, and it is intended that common sense
    8: and good judgement will prevail.
    9: 
   10: ## Support
   11: 
   12: iperf3 is officially supported on Linux (various distributions),
   13: FreeBSD, and macOS.  Support may be provided on a best-effort basis to
   14: other UNIX-like platforms.  We cannot provide support for building
   15: and/or running iperf3 on Windows, iOS, or Android.
   16: 
   17: Before asking for help, please use your favorite search engine or
   18: questions site (such as Stack Overflow) to see if your question might
   19: have been asked (and maybe even answered) before.
   20: https://fasterdata.es.net/ has some information on the use of various
   21: bandwidth measurement tools, including iperf3.  The iperf3
   22: documentation Web site at http://software.es.net/iperf/ contains
   23: various bits of helpful information, including a list of
   24: [frequently-asked questions](http://software.es.net/iperf/faq.html).
   25: 
   26: We specifically discourage the use of the issue tracker on the iperf3
   27: GitHub project page for asking questions.  Questions posted in the
   28: form of issues may go unanswered.  Please use a questions site
   29: such as [Stack Overflow](http://www.stackoverflow.com)
   30: to ask questions of the community or
   31: alternatively use the iperf3 mailing list at
   32: iperf-dev@googlegroups.com (posting requires joining the list).
   33: 
   34: ## Code
   35: 
   36: If you have improvements or bugfixes to make to iperf3, we'd love to
   37: hear from you.  We prefer changes to be submitted in the form of pull
   38: requests on GitHub, although we can (probably) accept simple patches
   39: as well.  If in doubt, ask.
   40: 
   41: Before making any submission to the iperf3 project (whether it be code
   42: or documentation), we urge you to consult the iperf3 license, in
   43: particular the section quoted below:
   44: 
   45: ```
   46: You are under no obligation whatsoever to provide any bug fixes, patches, or
   47: upgrades to the features, functionality or performance of the source code
   48: ("Enhancements") to anyone; however, if you choose to make your Enhancements
   49: available either publicly, or directly to Lawrence Berkeley National
   50: Laboratory, without imposing a separate written license agreement for such
   51: Enhancements, then you hereby grant the following license: a non-exclusive,
   52: royalty-free perpetual license to install, use, modify, prepare derivative
   53: works, incorporate into other computer software, distribute, and sublicense
   54: such enhancements or derivative works thereof, in binary and source code form.
   55: ```
   56: 
   57: If you're considering changes that will have an architectural impact,
   58: we strongly encourage discussing them with the iperf3 maintainers
   59: before doing a significant amount of work on the code.  We might be
   60: able to provide some guidance.  Also, we're more likely to accept a
   61: submission if if it doesn't involve rewriting large sections of the
   62: code.  Even if you're going to fork the code and maintain your own
   63: changes privately (which you're perfectly welcome to do) we might able
   64: to give you guidance so that future iperf3 changes won't conflict with
   65: your work.
   66: 
   67: ## Conduct
   68: 
   69: We expect that iperf3 interactions via the issue tracker, mailing
   70: lists, and so forth will be conducted civilly.  Language that is
   71: deemed appropriate or abusive may be removed, and we reserve the right
   72: to ban users from accessing the project for repeated offense.