github.com/k8snetworkplumbingwg/sriov-network-operator@v1.2.1-0.20240408194816-2d2e5a45d453/CONTRIBUTING.md (about)

     1  # SRIOV Network Operator
     2  
     3  * [Meetings](#meetings)
     4  * [How to Contribute](#contributing-code)
     5  * [Coding Style](#coding-style)
     6  * [Format of the patch](#format-of-the-patch)
     7  * [Contributing Code](#contributing-code)
     8  * [Tools](#Tools)
     9  
    10  ## Meetings
    11  Join us for project discussions at _K8s Network & Resource management_ meetings.
    12  The meetings take place on a weekly basis on Monday and Tuesday in alternating weeks:
    13  
    14  * Time: 15:00 - 16:00 GMT / 10:00-11:00 ET /  07:00-08:00 PST  every other Monday
    15  * Time: 14:00 - 15:00 GMT / 09:00-10:00 ET / 06:00-07:00 PST on every other Tuesday
    16  
    17  
    18  * [Meeting notes and agenda](https://docs.google.com/document/d/1sJQMHbxZdeYJPgAWK1aSt6yzZ4K_8es7woVIrwinVwI/edit?usp=sharing)
    19  * [Zoom channel](https://us02web.zoom.us/j/88973596231?pwd=UHZtUEtNSVBSYnRLL3A3cHMzdmlvZz09)
    20  
    21  ## How to Contribute
    22  
    23  SRIOV Network Operator is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub pull requests.
    24  This document outlines some of the conventions on development workflow, commit message formatting,
    25  contact points and other resources to make it easier to get your contribution accepted.
    26  
    27  ## Coding Style
    28  
    29  Please follows 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).
    30  
    31  ## Format of the patch
    32  
    33  Each patch is expected to comply with the following format:
    34  
    35  ```
    36  Change summary
    37  
    38  More detailed explanation of your changes: Why and how.
    39  Wrap it to 72 characters.
    40  See [here] (http://chris.beams.io/posts/git-commit/)
    41  for some more good advices.
    42  
    43  [Fixes #NUMBER (or URL to the issue)]
    44  ```
    45  
    46  For example:
    47  
    48  ```
    49  Fix poorly named identifiers
    50    
    51  One identifier, fnname, in func.go was poorly named.  It has been renamed
    52  to fnName.  Another identifier retval was not needed and has been removed
    53  entirely.
    54  
    55  Fixes #1
    56  ``` 
    57  
    58  ## Contributing Code
    59  
    60  We always encourage the contribution for the community project. We like to collaborate with various stake holder on this project. We ask developer to keep following guidelines in mind before the contribution.
    61  
    62  * Make sure to create an [Issue](https://github.com/k8snetworkplumbingwg/sriov-network-operator/issues) for bug fix or the feature request.
    63  Issues are discussed on a regular basis at _K8s Network & Resource management_ meetings. 
    64  * **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.
    65  * **For feature requests**, For the feature requests, please follow the issue template format while creating a feature requests. We want to improve upon SRIOV Network Operator incrementally which means small changes or features at a time.
    66    * Please make sure each PR are compiling or passed by Travis.
    67    * In order to ensure your PR can be reviewed in a timely manner, please keep PRs small 
    68  
    69  Once you're ready to contribute code back to this repo, start with these steps:
    70  * Fork the appropriate sub-projects that are affected by your change.
    71  * Clone the fork to your machine:
    72  
    73  ```
    74  $ git clone https://github.com/k8snetworkplumbingwg/sriov-network-operator.git
    75  ```
    76  
    77  * Create a topic branch with prefix `dev/` for your change and checkout that branch:
    78  
    79  ```
    80  $ git checkout -b dev/some-topic-branch
    81  ```
    82  * Make your changes to the code and add tests to cover contributed code.
    83  * Run `make all` to validate it builds and will not break current functionality.
    84  * Commit your changes and push them to your fork.
    85  * Open a pull request for the appropriate project.
    86  * Contributors will review your pull request, suggest changes, run tests and eventually merge or close the request.
    87  
    88  > We encourage contributor to test SRIOV Network Operator with various NICs to check the compatibility.
    89  >
    90  ## Contact Us
    91  - General channel on [NPWG](https://npwg-team.slack.com/) Slack. Request an invite to NPWG slack [here](https://intel-corp.herokuapp.com/).
    92  - Feel free to post GitHub issues and PRs for review
    93  - Attend either K8s Network & Resource mangement or Additional K8s Network & Resource management meetings