-
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
1 changed file
with
20 additions
and
12 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,12 +2,13 @@ | |
|
||
## Some Ways to Contribute | ||
|
||
- Report potential bugs. | ||
- Suggest product enhancements. | ||
- Increase our test coverage. | ||
- Fix a bug. | ||
- Implement a requested enhancement. | ||
- Improve our guides and documentation. L3af Guides, Docs, and api godoc are deployed from this repo. | ||
- Report potential bugs | ||
- Suggest product enhancements | ||
- Increase our test coverage | ||
- Fix a bug | ||
- Implement a requested enhancement | ||
- Improve our guides and documentation | ||
- Contribute code | ||
|
||
## Clone and Provision Environment | ||
|
||
|
@@ -29,9 +30,16 @@ git remote add upstream https://github.com/l3af-project/l3afd.git | |
|
||
## Pull Requests guidelines | ||
|
||
We actively welcome your pull requests. | ||
|
||
- If you've added code that should be tested, add tests. | ||
- If you've changed APIs, update the documentation. | ||
- Ensure the test suite passes. | ||
- Make sure your code lints. | ||
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 | ||
to make describing the change and context around it. This gives the l3af team a chance to review | ||
the issue and provide feedback and work with you on the change. If you have any questions, please | ||
feel free to reach out to the l3af team via [Slack](https://app.slack.com/client/T02GD9YQJUT/C02GRTC0SAD) or | ||
[mail]([email protected]) group. Below are some general guidelines to help ensure a successful PR approval. | ||
|
||
- Provide background why you are making the change and the issue it addresses | ||
- 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 | ||
- Ensure all tests pass and that your code lints |