Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (66 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

92 lines (66 loc) · 3.92 KB

DRA Driver for SR-IOV Virtual Functions

Meetings

Join us for project discussions at K8s Network & Resource management meetings. The meetings take place on a weekly basis on Monday and Tuesday in alternating weeks:

  • Time: 15:00 - 16:00 GMT / 10:00-11:00 ET / 07:00-08:00 PST on every other Monday

  • Time: 14:00 - 15:00 GMT / 09:00-10:00 ET / 06:00-07:00 PST on every other Tuesday

  • Meeting notes and agenda

  • Google Meet

How to Contribute

DRA Driver for SR-IOV Virtual Functions is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

Coding Style

Please follow the standard formatting recommendations and language idioms set out in Effective Go and in the Go Code Review Comments wiki.

Format of the patch

Each patch is expected to comply with the following format:

Change summary

More detailed explanation of your changes: Why and how.
Wrap it to 72 characters.
See [here](http://chris.beams.io/posts/git-commit/)
for some more good advices.

[Fixes #NUMBER (or URL to the issue)]

For example:

Fix poorly named identifiers
  
One identifier, fnname, in func.go was poorly named.  It has been renamed
to fnName.  Another identifier retval was not needed and has been removed
entirely.

Fixes #1

Contributing Code

We encourage contributions to this community project and collaborate with various stakeholders. Please keep the following guidelines in mind before contributing:

  • Make sure to create an Issue for bug fix or the feature request. Issues are discussed regularly at K8s Network & Resource management meetings.
  • 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.
  • 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.
  • Ensure each PR compiles and passes CI.
  • To ensure timely review, keep PRs small.

Once you're ready to contribute code back to this repo, start with these steps:

  • Fork the appropriate sub-projects that are affected by your change.
  • Clone the fork to your machine:
git clone https://github.com/k8snetworkplumbingwg/dra-driver-sriov.git
  • Create a topic branch with prefix dev/ for your change and checkout that branch:
git checkout -b dev/some-topic-branch
  • Make your changes to the code and add tests to cover contributed code.
  • Run make all to validate it builds and will not break current functionality.
  • Commit your changes and push them to your fork.
  • Open a pull request for the appropriate project.
  • Contributors will review your pull request, suggest changes, run tests and eventually merge or close the request.

We encourage contributors to test DRA Driver for SR-IOV Virtual Functions with various NICs to check the compatibility.

Contact Us

  • General channel on NPWG Slack.
  • Post GitHub issues and PRs for review
  • Attend either K8s Network & Resource management or Additional K8s Network & Resource management meetings