|
| 1 | +## Contributing In General |
| 2 | +Our project welcomes external contributions. |
| 3 | + |
| 4 | +To contribute code or documentation, please submit a [pull request](https://github.com/sysflow-telemetry/sf-apis/pulls). |
| 5 | + |
| 6 | +A good way to familiarize yourself with the codebase and contribution process is |
| 7 | +to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/sysflow-telemetry/sf-apis/issues). |
| 8 | +Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us. |
| 9 | + |
| 10 | +**Note: We appreciate your effort, and want to avoid a situation where a contribution |
| 11 | +requires extensive rework (by you or by us), sits in backlog for a long time, or |
| 12 | +cannot be accepted at all!** |
| 13 | + |
| 14 | +### Proposing new features |
| 15 | + |
| 16 | +If you would like to implement a new feature, please [raise an issue](https://github.com/sysflow-telemetry/sf-apis/issues) |
| 17 | +before sending a pull request so the feature can be discussed. This is to avoid |
| 18 | +you wasting your valuable time working on a feature that the project developers |
| 19 | +are not interested in accepting into the code base. |
| 20 | + |
| 21 | +### Fixing bugs |
| 22 | + |
| 23 | +If you would like to fix a bug, please [raise an issue](https://github.com/sysflow-telemetry/sf-apis/issues) before sending a |
| 24 | +pull request so it can be tracked. |
| 25 | + |
| 26 | +### Merge approval |
| 27 | + |
| 28 | +The project maintainers use LGTM (Looks Good To Me) in comments on the code |
| 29 | +review to indicate acceptance. A change requires LGTMs from two of the |
| 30 | +maintainers of each component affected. |
| 31 | + |
| 32 | +For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page. |
| 33 | + |
| 34 | +## Legal |
| 35 | + |
| 36 | +Each source file must include a license header for the Apache |
| 37 | +Software License 2.0. Using the SPDX format is the simplest approach. |
| 38 | +e.g. |
| 39 | + |
| 40 | +``` |
| 41 | +/* |
| 42 | +Copyright <holder> All Rights Reserved. |
| 43 | +
|
| 44 | +SPDX-License-Identifier: Apache-2.0 |
| 45 | +*/ |
| 46 | +``` |
| 47 | + |
| 48 | +We have tried to make it as easy as possible to make contributions. This |
| 49 | +applies to how we handle the legal aspects of contribution. We use the |
| 50 | +same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin) |
| 51 | +uses to manage code contributions. |
| 52 | + |
| 53 | +We simply ask that when submitting a patch for review, the developer |
| 54 | +must include a sign-off statement in the commit message. |
| 55 | + |
| 56 | +Here is an example Signed-off-by line, which indicates that the |
| 57 | +submitter accepts the DCO: |
| 58 | + |
| 59 | +``` |
| 60 | +Signed-off-by: John Doe <[email protected]> |
| 61 | +``` |
| 62 | + |
| 63 | +You can include this automatically when you commit a change to your |
| 64 | +local git repository using the following command: |
| 65 | + |
| 66 | +``` |
| 67 | +git commit -s |
| 68 | +``` |
| 69 | + |
| 70 | +## Communication |
| 71 | +Please feel free to connect with us on our [Slack channel](https://join.slack.com/t/sysflow-telemetry/shared_invite/enQtODA5OTA3NjE0MTAzLTlkMGJlZDQzYTc3MzhjMzUwNDExNmYyNWY0NWIwODNjYmRhYWEwNGU0ZmFkNGQ2NzVmYjYxMWFjYTM1MzA5YWQ) or |
| 72 | +via [email ](mailto:[email protected]). 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. |
| 73 | + |
| 74 | +## Setup |
| 75 | + |
| 76 | +The documentation is a work in progress but should provide a good overview on how to get started with the project. |
| 77 | + |
| 78 | +## Testing |
| 79 | + |
| 80 | +This project is in its infancy and with limited resources we haven't built a testing framework around the apis. |
| 81 | + |
| 82 | + |
| 83 | +## Coding style guidelines |
| 84 | +We follow the [LLVM Coding standards](https://llvm.org/docs/CodingStandards.html) in this project. There is a .clang-format file in the master repo [clang-format](https://github.com/sysflow-telemetry/sf-apis/blob/master/src/.clang-format) that can be used in conjunction with [ClangFormat Tool](https://clang.llvm.org/docs/ClangFormat.html) to automatically format code. For linting, |
| 85 | +we use [Clang Tidy Linter](https://clang.llvm.org/extra/clang-tidy/). This is referenced in the Makefile. |
0 commit comments