How to Contribute

Questions? Found a bug? Have a request for new features?

Great. You can use GitHub Issues for any questions, suggestions, or issues. Please do not email individuals.

Contributions to this Wiki

This Wiki is open to everyone for edit. Feel free to add any changes, it can be a big help for others!

Sending patches

You are welcome to make a GitHub Pull Request for new features and bug fixes.

Coding Style

Please follow the following coding styles. Let's not be too dogmatic though.

• C++: Google C++ Style Guide
  • There is a .clang_format file that you can utilize directly with clang-format or integrate with your favorite editor (Vim, Emacs, Atom, etc.)
• C: Linux kernel coding style
  • Currently C is only used for the Linux kernel module.
• Python: PEP 8 -- Style Guide for Python Code
  • For new code, please make it compatible with both Python 2 and 3.

Add your name to the contributor list.

Unless you want to remain anonymous, please update CONTRIBUTORS.md and include the file in your pull request.

Running Tests

Running BESS unit tests is recommended before committing a patch, the following execute runs all unit tests: /core/all_tests It is recommended to add new tests for new code.

Sanity Check

When changing core functionality it is also recommended to run [sanity_check.sh] (https://github.com/NetSys/bess/blob/master/sanity_check.sh) script in the root DIR which runs few script files and verify system aliveness.

Code Review

All Pull Requests will be reviewed to maintain high code quality. Everyone is welcome to join the process of reviewing code. Please understand that others may request further changes to your Pull Request for errors, coding styles, etc.