Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

100 lines (71 loc) · 3.09 KB
Raw

This repository contains sample code that shows how to use the NSX-T API, and specifically, how to use the NSX-T Java and Python SDKs to create and manage virtual networks. You can download these SDKs from the VMWARE {code}(tm) web site at https://code.vmware.com/home.

Contributing to nsx-t

Before you start working with the nsx-t samples, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Create a topic branch from where you want to base your work
  • Make commits of logical units
  • Make sure your commit messages are in the proper format (see below)
  • Push your changes to a topic branch in your fork of the repository
  • Submit a pull request

Example:

git remote add upstream https://github.com/vmware/nsx-t.git
git checkout -b my-new-feature master
git commit -a
git push origin my-new-feature

Staying In Sync With Upstream

When your branch gets out of sync with the vmware/master branch, use the following to update:

git checkout my-new-feature
git fetch -a
git pull --rebase upstream master
git push --force-with-lease origin my-new-feature

Updating pull requests

If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into existing commits.

If your pull request contains a single commit or your changes are related to the most recent commit, you can simply amend the commit.

git add .
git commit --amend
git push --force-with-lease origin my-new-feature

If you need to squash changes into an earlier commit, you can use:

git add .
git commit --fixup <commit>
git rebase -i --autosquash master
git push --force-with-lease origin my-new-feature

Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a notification when you git push.

Code Style

Please run the pep8 style checker on your code and fix any style problems before submitting a pull request.

Formatting Commit Messages

We follow the conventions on How to Write a Git Commit Message.

Be sure to include any related GitHub issue references in the commit message. See GFM syntax for referencing issues and commits.

Reporting Bugs and Creating Issues

When opening a new issue, try to roughly follow the commit message format conventions above.

Repository Structure

./java - SDK samples for the Java programming language

  • the Java examples are structured as a Maven repository and can be compiled with the command "mvn install". For more information, read the README.md file in the java directory.

./python - SDK samples for the Python programming language

  • For more information, read the README.md file in the python directory.