Skip to content

Commit 9b2ef23

Browse files
committed
chore: add CONTRIBUTING.md
Signed-off-by: Fred Rolland <frolland@nvidia.com>
1 parent 423e878 commit 9b2ef23

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

CONTRIBUTING.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# DRA Driver for SR-IOV Virtual Functions
2+
3+
* [Meetings](#meetings)
4+
* [How to Contribute](#how-to-contribute)
5+
* [Coding Style](#coding-style)
6+
* [Format of the patch](#format-of-the-patch)
7+
* [Contributing Code](#contributing-code)
8+
9+
## Meetings
10+
Join us for project discussions at _K8s Network & Resource management_ meetings.
11+
The meetings take place on a weekly basis on Monday and Tuesday in alternating weeks:
12+
13+
* Time: 15:00 - 16:00 GMT / 10:00-11:00 ET / 07:00-08:00 PST every other Monday
14+
* Time: 14:00 - 15:00 GMT / 09:00-10:00 ET / 06:00-07:00 PST on every other Tuesday
15+
16+
17+
* [Meeting notes and agenda](https://docs.google.com/document/d/1sJQMHbxZdeYJPgAWK1aSt6yzZ4K_8es7woVIrwinVwI/edit?usp=sharing)
18+
* [Zoom channel](https://us02web.zoom.us/j/88973596231?pwd=UHZtUEtNSVBSYnRLL3A3cHMzdmlvZz09)
19+
20+
## How to Contribute
21+
22+
DRA Driver for SR-IOV Virtual Functions is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub pull requests.
23+
This document outlines some of the conventions on development workflow, commit message formatting,
24+
contact points and other resources to make it easier to get your contribution accepted.
25+
26+
## Coding Style
27+
28+
Please follow the standard formatting recommendations and language idioms set out in [Effective Go](https://golang.org/doc/effective_go.html) and in the [Go Code Review Comments wiki](https://github.com/golang/go/wiki/CodeReviewComments).
29+
30+
## Format of the patch
31+
32+
Each patch is expected to comply with the following format:
33+
34+
```text
35+
Change summary
36+
37+
More detailed explanation of your changes: Why and how.
38+
Wrap it to 72 characters.
39+
See [here](http://chris.beams.io/posts/git-commit/)
40+
for some more good advices.
41+
42+
[Fixes #NUMBER (or URL to the issue)]
43+
```
44+
45+
For example:
46+
47+
```text
48+
Fix poorly named identifiers
49+
50+
One identifier, fnname, in func.go was poorly named. It has been renamed
51+
to fnName. Another identifier retval was not needed and has been removed
52+
entirely.
53+
54+
Fixes #1
55+
```
56+
57+
## Contributing Code
58+
59+
We encourage contributions to this community project and collaborate with various stakeholders. Please keep the following guidelines in mind before contributing:
60+
61+
* Make sure to create an [Issue](https://github.com/k8snetworkplumbingwg/dra-driver-sriov/issues) for bug fix or the feature request.
62+
Issues are discussed regularly at _K8s Network & Resource management_ meetings.
63+
* **For bugs**: For the bug fixes, please follow the issue template format while creating a issue. If you have already found a fix, feel free to submit a Pull Request referencing the Issue you created. Include the `Fixes #` syntax to link it to the issue you're addressing.
64+
* **For feature requests**: Please follow the issue template format while creating a feature request. We want to improve upon DRA Driver for SR-IOV incrementally which means small changes or features at a time.
65+
* Ensure each PR compiles and passes CI.
66+
* To ensure timely review, keep PRs small.
67+
68+
Once you're ready to contribute code back to this repo, start with these steps:
69+
* Fork the appropriate sub-projects that are affected by your change.
70+
* Clone the fork to your machine:
71+
72+
```bash
73+
git clone https://github.com/k8snetworkplumbingwg/dra-driver-sriov.git
74+
```
75+
76+
* Create a topic branch with prefix `dev/` for your change and checkout that branch:
77+
78+
```bash
79+
git checkout -b dev/some-topic-branch
80+
```
81+
* Make your changes to the code and add tests to cover contributed code.
82+
* Run `make all` to validate it builds and will not break current functionality.
83+
* Commit your changes and push them to your fork.
84+
* Open a pull request for the appropriate project.
85+
* Contributors will review your pull request, suggest changes, run tests and eventually merge or close the request.
86+
87+
> We encourage contributors to test DRA Driver for SR-IOV Virtual Functions with various NICs to check the compatibility.
88+
>
89+
## Contact Us
90+
- General channel on [NPWG](https://npwg-team.slack.com/) Slack.
91+
- Post GitHub issues and PRs for review
92+
- Attend either K8s Network & Resource management or Additional K8s Network & Resource management meetings

0 commit comments

Comments
 (0)