Contribution

We would like to thank all of our users and contributors for their help and support, including:

Submitting contributions

The syslog-ng application is an open source project that relies heavily on community contributions. Contribution is not necessarily program code: documentation, configuration examples, usage scenarios, benchmarking and other test results are also very useful. The following gives you a summary on how to submit contributions to the syslog-ng maintainers, in order to get it integrated into syslog-ng as soon as possible.

Code contributions

If you have created a patch, please make sure that:

• your patch is based on the contents of the syslog-ng GIT repository, or at least on the latest released version (for details on accessing the GIT repository, see the GIT instructions);
• the patch adheres to the syslog-ng coding conventions (no formal document describing this has been posted yet, but if you follow the naming scheme and indentation of the existing code base, then it is probably fine);
• please sign your patches with a "Signed-off-by" to indicate that you have all rights to submit your work to be used by the syslog-ng project. We're using the same "Developer's Certificate of Origin v1.1" as the Linux kernel developers do. For a reference, here's a copy of that document and what this signed-off-by line means:

11) Sign your work

To improve tracking of who did what, especially with patches that can
percolate to their final resting place in the kernel through several
layers of maintainers, we've introduced a "sign-off" procedure on
patches that are being emailed around.

The sign-off is a simple line at the end of the explanation for the
patch, which certifies that you wrote it or otherwise have the right to
pass it on as a open-source patch.  The rules are pretty simple: if you
can certify the below:

        Developer's Certificate of Origin 1.1

        By making a contribution to this project, I certify that:

        (a) The contribution was created in whole or in part by me and I
            have the right to submit it under the open source license
            indicated in the file; or

        (b) The contribution is based upon previous work that, to the best
            of my knowledge, is covered under an appropriate open source
            license and I have the right under that license to submit that
            work with modifications, whether created in whole or in part
            by me, under the same open source license (unless I am
            permitted to submit under a different license), as indicated
            in the file; or

        (c) The contribution was provided directly to me by some other
            person who certified (a), (b) or (c) and I have not modified
            it.

        (d) I understand and agree that this project and the contribution
            are public and that a record of the contribution (including all
            personal information I submit with it, including my sign-off) is
            maintained indefinitely and may be redistributed consistent with
            this project or the open source license(s) involved.

then you just add a line saying

    Signed-off-by: Random J Developer <random@developer.org>

Some people also put extra tags at the end.  They'll just be ignored for
now, but you can do this to mark internal company procedures or just
point out some special detail about the sign-off.

Please post patches or git pull requests to syslog-ng@lists.balabit.hu mailing list.

Documentation contributions

The official documentation of syslog-ng includes of the following items:

• The syslog-ng Administrator Guide
• The manual pages of syslog-ng

These documents are maintained internally by the BalaBit Documentation Team. If you have any suggestions, clarifications, or any other kind of documentation related comments, please write a mail to documentation@balabit.com