CONTRIBUTING.TXT

Contributors Guide
==================

This document outlines how to contribute code to the PKTGEN project.

Getting the code
----------------

The PKTGEN code can be cloned from the repository on Github as follows:

    git clone https://github.com/pktgen/Pktgen-DPDK.git

The code can be browsed at https://github.com/pktgen/Pktgen-DPDK

Submitting Patches
------------------

Contributions to PKTGEN should be submitted as merge requests on Github.

The commit message must end with a "Signed-off-by:" line which is added using:

    git commit --signoff # or -s

The purpose of the signoff is explained in the Linux kernel guidelines
Developer's Certificate of Origin:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html

Note:
    All developers must ensure that they have read, understood and complied
    with the Developer's Certificate of Origin section of the documentation
    prior to applying the signoff and submitting a patch.

The DPDK Code Contributors guidelines contain information that is
useful for submitting patches to PKTGEN:
http://dpdk.org/doc/guides/contributing/index.html

Coding Guidelines
-----------------

* C code should follow the DPDK coding standards.
* Lua code should follow existing code.

Maintainer
----------

The PKTGEN maintainer is: Keith Wiles <keith.wiles@intel.com>