Contributing In General¶
Our project welcomes external contributions.
To contribute code or documentation, please submit a pull request to the proper github repositories.
A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the github issue trackers associated with projects. Before embarking on a more ambitious contribution, please quickly get in touch with us.
Note: We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or cannot be accepted at all!
Proposing new features¶
If you would like to implement a new feature, please raise an issue in the appropriate repository before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.
If you would like to fix a bug, please raise an issue in the appropriate repository before sending a pull request so it can be tracked.
The project maintainers use LGTM (Looks Good To Me) in comments on the code review to indicate acceptance. A change requires LGTMs from two of the maintainers of each component affected.
For a list of the maintainers, see the MAINTAINERS.md page in the appropriate repository.
Each source file must include a license header for the Apache Software License 2.0. Using the SPDX format is the simplest approach. e.g.
/* Copyright <holder> All Rights Reserved. SPDX-License-Identifier: Apache-2.0 */
We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the same approach - the Developer’s Certificate of Origin 1.1 (DCO) - that the Linux® Kernel community uses to manage code contributions.
We simply ask that when submitting a patch for review, the developer must include a sign-off statement in the commit message.
Here is an example Signed-off-by line, which indicates that the submitter accepts the DCO:
Signed-off-by: John Doe <firstname.lastname@example.org>
You can include this automatically when you commit a change to your local git repository using the following command:
git commit -s
Please feel free to connect with us on our Slack channel or via email. Note that the projects in this repository are not formal products. As a result, the communication channels are to the maintainers and not to a support staff.
The documentation is a work in progress but should provide a good overview on how to get started with the project. The Dockerfile also provides a treasure trove of information on how to build the application, dependencies, and how to test the collector.
This project is in its infancy and with limited resources we haven’t built many testers for the projects. For the sf-collector, we do have a set of unit tests that test the coverage of most of the events of interest in
These tests can be run using the bats testing framework. Directions on how to install bats are in the accompanied link. To run the tests, run
bats -t tests.bat from the tests directory. Note,
that the tests also rely on python3. Before conducting a pull request, these unit tests should be run. Note, there is a version of the docker image with a
testing tag that contains bats and the unit tests. This might be useful for testing.
Also, conducting a load test and running the application under valgrind is desirable for pull requests.
Coding style guidelines¶
We follow the LLVM Coding standards where possible across the projects. There is a .clang-format file in the master repo clang-format that can be used in conjunction with ClangFormat Tool to automatically format code. For linting, we use Clang Tidy Linter. This is referenced in the sf-collector Makefile.