CONTRIBUTING.md

   1 # Contributing to Wireshark
   2
   3 <!--
   4 To do:
   5 - Provide an overview of project governance.
   6 - CoC?
   7 - Sponsorship?
   8 - SharkFest?
   9 -->
  10
  11 Thank you for your interest in contributing to Wireshark!
  12 We wouldn’t be as successful as we are today without the help of our community.
  13 There are many ways to contribute and help improve Wireshark.
  14
  15 ## Help People Use Wireshark
  16
  17 It’s not always obvious how to capture traffic or interpret what Wireshark shows you.
  18 We provide two primary ways to ask for help: the question and answer site at
  19 https://ask.wireshark.org/
  20 and a mailing list at
  21 [wireshark-users@wireshark.org](https://www.wireshark.org/lists/).
  22 Your constructive and respectful assistance is welcome in both places.
  23
  24 ## Report Issues
  25
  26 If you run across a problem with Wireshark or have a suggestion for improvement, you’re welcome to tell us about it on our [issue tracker](https://gitlab.com/wireshark/wireshark/-/issues).
  27 When creating an issue, please select from one of the predefined templates and fill in each section as needed.
  28 You can increase the likelihood that a bug will be fixed by providing any materials or information required to replicate the issue.
  29 For most issues this means uploading a capture file, but please make sure that it doesn’t contain any private or sensitive information.
  30
  31 The User’s Guide also has a section on [reporting problems](https://www.wireshark.org/docs/wsug_html_chunked/ChIntroHelp.html#_reporting_problems).
  32
  33 ## Write Code And Documentation
  34
  35 Wireshark is primarily written in C, with the exception of the main application UI, which is written in C++.
  36 You can find its source code at https://gitlab.com/wireshark/wireshark/-/tree/master.
  37 You can set up a [build environment](https://www.wireshark.org/docs/wsdg_html_chunked/PartEnvironment.html) on Windows, UNIX, and UNIX-like platforms, including macOS and Linux.
  38
  39 If you would like to contribute changes to Wireshark’s source code, you must create a [merge request](https://gitlab.com/wireshark/wireshark/-/merge_requests).
  40 Complete details on doing so can be found in the [Developer’s Guide](https://www.wireshark.org/docs/wsdg_html_chunked/ChSrcContribute.html) and on the [wiki](https://gitlab.com/wireshark/wireshark/-/wikis/Development/SubmittingPatches).
  41 When you submit a merge request, a series of automated tests will be run in order to ensure that compiles across different platforms and conforms to our coding guidelines.
  42 The change will also be manually reviewed by a core developer and will be merged when the change passes both automated and manual review.
  43
  44 The Wireshark User’s Guide and Developer’s Guide are maintained in the [doc directory](https://gitlab.com/wireshark/wireshark/-/tree/master/doc) in the main repository.
  45 You don’t need a complete development environment to contribute to them, but you do need git and a text editor.
  46 Documentation updates must be made via a merge request similar to source code changes.