-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Santhosh Fernandes <[email protected]>
- Loading branch information
Showing
2 changed files
with
44 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,18 @@ | ||
# How To Contribute | ||
|
||
## Some Ways to Contribute | ||
- Getting started with [L3AF](https://wiki.lfnetworking.org/display/L3AF/Getting+Started+with+L3AF) | ||
- Report potential bugs | ||
- Suggest product enhancements | ||
- Increase our test coverage | ||
- Fix a bug | ||
- Implement a requested enhancement | ||
- Improve our guides and documentation | ||
- Contribute code | ||
- [Getting started with L3AF](#getting-started-with-l3af) | ||
- [Report potential bugs](#report-potential-bugs) | ||
- [New Features or product enhancements](#new-features-or-product-enhancements) | ||
- [Submitting a patch that fixes a bug](#submitting-a-patch-that-fixes-a-bug) | ||
- [Contribute code](#coding-style) | ||
- [Guidelines for pull requests](#guidelines-for-pull-requests) | ||
- [Improve our guides and documentation](#improve-our-guides-and-documentation) | ||
- [Increase our test coverage](#increase-our-test-coverage) | ||
|
||
### Getting started with L3AF | ||
|
||
See [L3AF](https://wiki.lfnetworking.org/display/L3AF/Getting+Started+with+L3AF) | ||
|
||
### Report potential bugs | ||
|
||
|
@@ -20,12 +24,22 @@ If you did not find a related bug, you can help us by | |
A good bug report provides a detailed description of the issue and step-by-step instructions | ||
for reliably reproducing the issue. | ||
|
||
We will aim to triage issues in weekly TSC meetings. In case we are unable to repro the issue, | ||
we will request more information from you. There will be a waiting period of 2 weeks | ||
for the requested information and if there is no response, the issue will be closed. If this happens, | ||
We will aim to triage issues in [weekly TSC meetings](https://wiki.lfnetworking.org/display/L3AF/Community+Meetings). | ||
In case we are unable to repro the issue, we will request more information from you. There will be a waiting period of | ||
2 weeks for the requested information and if there is no response, the issue will be closed. If this happens, | ||
please reopen the issue if you do get a repro and provide the requested information. | ||
|
||
If you found a security issue, please do not open a GitHub Issue, and instead [email]([email protected]) it in detail. | ||
If you found a security issue, please do not open a GitHub Issue, and instead [email]([email protected]) it in detail. | ||
|
||
### New Features or product enhancements | ||
|
||
You can request a new feature by [submitting a GitHub Issue](https://github.com/l3af-project/l3afd/issues/new). | ||
|
||
If you would like to implement a new feature, please first | ||
[submit a GitHub Issue](https://github.com/l3af-project/l3afd/issues/new) and | ||
communicate your proposal so that the L3AF community can review and provide feedback. Getting | ||
early feedback will help ensure your implementation work is accepted by the community. | ||
This will also allow us to better coordinate our efforts and minimize duplicated effort. | ||
|
||
### Submitting a patch that fixes a bug | ||
|
||
|
@@ -34,7 +48,7 @@ Fork the repo and make your changes. Then open a new GitHub pull request with th | |
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number | ||
if applicable. | ||
|
||
## Guidelines for pull Requests | ||
### Guidelines for pull requests | ||
|
||
Great, you want to directly contribute to the l3af project and submit a pull request. | ||
It is recommended prior to working on a PR to submit an issue in github for the change you want | ||
|
@@ -47,22 +61,28 @@ feel free to reach out to the l3af team via [Slack](https://app.slack.com/client | |
- List what is changing and provide a high-level summary of the change | ||
- List any relevant dependencies linked to this change | ||
- Describe the tests that you ran to verify your changes and add/update test cases | ||
- Update relevant docs, especially if you've change API's | ||
- Update relevant docs, especially if you've change APIs | ||
- Ensure all GitHub CI/CD checks pass | ||
|
||
## Coding Style | ||
### Coding Style | ||
|
||
Follow [uber-go](https://github.com/uber-go/guide/blob/master/style.md) coding style | ||
See [uber-go](https://github.com/uber-go/guide/blob/master/style.md) | ||
|
||
## New Features | ||
### Improve our guides and documentation | ||
|
||
You can request a new feature by [submitting a GitHub Issue](https://github.com/l3af-project/l3afd/issues/new). | ||
The community look forward to the improvement our guides and documentation. | ||
Documentation should be written in an inclusive style. The [Google developer documentation](https://developers.google.com/style/inclusive-documentation) | ||
contains an excellent reference on this topic. | ||
|
||
If you would like to implement a new feature, please first | ||
[submit a GitHub Issue](https://github.com/l3af-project/l3afd/issues/new) and | ||
communicate your proposal so that the L3AF community can review and provide feedback. Getting | ||
early feedback will help ensure your implementation work is accepted by the community. | ||
This will also allow us to better coordinate our efforts and minimize duplicated effort. | ||
### Increase our test coverage | ||
|
||
Increase the code coverage by adding the tests. PRs are expected to have 100% test coverage for added code. This can be | ||
verified with a coverage build. If your PR cannot have 100% coverage for some reason please clearly explain why when | ||
you open it. Run your tests and get coverage locally | ||
|
||
```bash | ||
go test -race -covermode=atomic -coverprofile=coverage.out | ||
``` | ||
|
||
## Developer Certificate of Origin (DCO) | ||
|
||
|