The following information must be in the README.md (or in the sample comments in case a README.md 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.
- Date
- The date that the sample was originally written
- Minimal/High Level Description
- What does the sample do? What is the purpose of the sample?
- Any KNOWN limitations or dependencies
Include the following information when possible. Inclusion of information provides valuable information to consumers of the resource.
- Which vSphere version was the sample developed/tested against?
- Whic SDK version was the sample developed/tested against?
- Whic Ruby version was the sample developed/tested against?
- Follow the GitHub process
- 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
Please conform to the Ruby Style Guide.
Check your code by running RuboCop
using Bundler (bundle exec rubocop [filename]).
The submitter will maintain ownership of all submitted samples.
File any bugs or other issues within GitHub by way of the repository's Issue Tracker.
Any community member can resolve issues within the repository, however only the board member can approve the update. Once approved, assuming the resolution involves a pull request, only a board member will be able to merge and close the request.