Skip to content

Commit f3e20f7

Browse files
committed
update CONTRIBUTING.md
1 parent 96b7092 commit f3e20f7

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
## Contributing In General
2-
Our project welcomes external contributions.
32

4-
To contribute code or documentation, please submit a [pull request](https://github.com/sysflow-telemetry/sf-apis/pulls).
3+
Our project welcomes external contributions. A good way to familiarize yourself with the codebase and the contribution process is to look for and address issues in the [issue tracker](https://github.com/sysflow-telemetry/sf-apis/issues).
54

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.
5+
To contribute code or documentation, please submit a [pull request](https://github.com/sysflow-telemetry/sf-apis/pulls); and please quickly [get in touch](#communication) with us before embarking on a more ambitious contribution.
96

107
**Note: We appreciate your effort, and want to avoid a situation where a contribution
118
requires extensive rework (by you or by us), sits in backlog for a long time, or
@@ -14,28 +11,27 @@ cannot be accepted at all!**
1411
### Proposing new features
1512

1613
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.
14+
before sending a pull request so that the proposed feature can be discussed first. This is to avoid
15+
putting an effort on a feature that the project developers would not be able to accept into the code base.
2016

2117
### Fixing bugs
2218

2319
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.
20+
pull request so that the bug fix can be tracked properly.
2521

2622
### Merge approval
2723

2824
The project maintainers use LGTM (Looks Good To Me) in comments on the code
2925
review to indicate acceptance. A change requires LGTMs from two of the
3026
maintainers of each component affected.
3127

32-
For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
28+
For a list of the maintainers, please see the [maintainers page](MAINTAINERS.md).
3329

3430
## Legal
3531

3632
Each source file must include a license header for the Apache
3733
Software License 2.0. Using the SPDX format is the simplest approach.
38-
e.g.
34+
For example,
3935

4036
```
4137
/*
@@ -77,9 +73,9 @@ The documentation is a work in progress but should provide a good overview on ho
7773

7874
## Testing
7975

80-
This project is in its infancy and with limited resources we haven't built a testing framework around the apis.
76+
This project is in its infancy and with limited resources we have not built a testing framework around the APIs.
8177

8278

8379
## 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-collector/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,
80+
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-collector/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,
8581
we use [Clang Tidy Linter](https://clang.llvm.org/extra/clang-tidy/). This is referenced in the Makefile.

0 commit comments

Comments
 (0)