Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

86 lines (62 loc) · 3.26 KB
Raw

Developer Guide

Thank you for taking the time out to contribute to project Antrea!

Contribute

Inclusive Naming

For symbol names and documentation, do not introduce new usage of harmful language such as 'master / slave' (or 'slave' independent of 'master') and 'blacklist / whitelist'. For more information about what constitutes harmful language and for a reference word replacement list, please refer to the Inclusive Naming Initiative.

We are committed to removing all harmful language from the project. If you detect existing usage of harmful language in code or documentation, please report the issue to us or open a Pull Request to address it directly. Thanks!

Sign-off Your Work

As a CNCF project, Antrea must enforce the Developer Certificate of Origin (DCO) on all Pull Requests. We require that for all commits constituting the Pull Request, the commit message contains the Signed-off-by line with an email address that matches the commit author. By adding this line to their commit messages, contributors sign-off that they adhere to the requirements of the DCO.

Git provides the -s command-line option to append the required line automatically to the commit message:

git commit -s -m 'This is my commit message'

For an existing commit, you can also use this option with --amend:

git commit -s --amend

If more than one person works on something it's possible for more than one person to sign-off on it. For example:

Signed-off-by: Some Developer somedev@example.com
Signed-off-by: Another Developer anotherdev@example.com

We use the DCO Github App to enforce that all commits in a Pull Request include the required Signed-off-by line. If this is not the case, the app will report a failed status for the Pull Request and it will be blocked from being merged.

Compared to our earlier CLA, DCO tends to make the experience simpler for new contributors. If you are contributing as an employee, there is no need for your employer to sign anything; the DCO assumes you are authorized to submit contributions (it's your responsibility to check with your employer).

Building and Testing your changes

Dependencies

  • Go >= 1.21
  • Yarn >= 1.22
  • After installing Yarn, install all the frontend dependencies with cd client/web/antrea-ui/ && yarn install. You will need to run this command every time a new dependency is added to the project by another developer.

Unit Tests

To run unit tests for the backend, use make test.

To run unit tests for the frontend, use cd client/web/antrea-ui/ && yarn test. If you are missing some dependencies, run yarn install before yarn test.

Running the UI locally

To run the UI locally, you will still need access to a K8s cluster and a Kubeconfig file with enough permissions (using the default / admin Kubeconfig is the easiest way).

  1. Build the backend with make bin.
  2. Run the backend with KUBECONFIG=<path to Kubeconfig> APP_ENV=dev ./bin/server.
  3. Run the frontend with cd client/web/antrea-ui/ && yarn start.
  4. You can access the UI in your browser by visiting http://localhost:3000/.