Return to CONTRIBUTING.md CVS log

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

Version 3.15

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