mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
|
## Submitting samples
|
||
|
|
|
||
|
|
### Developer Certificate of Origin
|
||
|
|
|
||
|
|
Before you start working with this project, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). 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.
|
||
|
|
|
||
|
|
### Sample Template
|
||
|
|
|
||
|
|
[Sample template](sample_template) contains boilerplate code that can be used to build a new sample.
|
||
|
|
Please copy the file and use it as a starting point to write a new sample.
|
||
|
|
|
||
|
|
### Required Information
|
||
|
|
|
||
|
|
The following information must be included in the README.md or in the sample docstring in case README already exists in same folder.
|
||
|
|
* Author Name
|
||
|
|
* This can include full name, email address or other identifiable piece of information that would allow interested parties to contact author with questions.
|
||
|
|
* Minimal/High Level Description
|
||
|
|
* What does the sample do ?
|
||
|
|
* Any KNOWN limitations or dependencies
|
||
|
|
|
||
|
|
### Suggested Information
|
||
|
|
|
||
|
|
The following information should be included when possible. Inclusion of information provides valuable information to consumers of the resource.
|
||
|
|
* vSphere version against which the sample was developed/tested
|
||
|
|
* SDK version against which the sample was developed/tested
|
||
|
|
* Python version against which the sample was developed/tested
|
||
|
|
|
||
|
|
### Contribution Process
|
||
|
|
|
||
|
|
* Follow the [GitHub process](https://help.github.com/articles/fork-a-repo)
|
||
|
|
* Please use one branch per sample or change-set
|
||
|
|
* Please use one commit and pull request per sample
|
||
|
|
* Please post the sample output along with the pull request
|
||
|
|
* If you include a license with your sample, use the project license
|
||
|
|
|
||
|
|
### Code Style
|
||
|
|
|
||
|
|
Please conform to pep8 standards. Check your code by running the pep8 tool.
|
||
|
|
https://pypi.python.org/pypi/pep8
|