Skip to content

Latest commit

 

History

History
68 lines (40 loc) · 2.94 KB

CONTRIBUTING_CLA.md

File metadata and controls

68 lines (40 loc) · 2.94 KB
Raw

Contributing to vm-packer-for-ray

We welcome contributions from the community and first want to thank you for taking the time to contribute!

Please familiarize yourself with the Code of Conduct before contributing.

Before you start working with vm-packer-for-ray, please read and sign our Contributor License Agreement CLA. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will prompt you to do so when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.

When you click the link for signing the CLA, please sign the individual CLA.

Important: Make sure you provide all the information we ask you to provide, e.g., fill in each blank in below form.

Ways to contribute

We welcome many different types of contributions and not all of them need a Pull request. Contributions may include:

  • New features and proposals
  • Documentation
  • Bug fixes
  • Issue Triage
  • Answering questions and giving feedback
  • Helping to onboard new contributors
  • Other related activities

Getting started

Please check the Advanced User Guide for information.

Contribution Flow

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

  • Make a fork of the repository within your GitHub account
  • Create a topic branch in your fork from where you want to base your work
  • Make commits of logical units
  • Make sure your commit messages are with the proper format, quality and descriptiveness (see below)
  • Push your changes to the topic branch in your fork
  • Create a pull request containing that commit

We follow the GitHub workflow and you can find more details on the GitHub flow documentation.

Pull Request Checklist

Before submitting your pull request, we advise you to use the following:

  1. Test you code locally an post the detailed test result on your drafted pull request.
  2. Ensure your commit messages are descriptive. 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.
  3. Check the commits and commits messages and ensure they are free from typos.

Reporting Bugs and Creating Issues

Please create an issue on the GitHub if you are aware of a bug.

Ask for Help

The best way to reach us with a question when contributing is to ask on:

  • The original GitHub issue

Additional Resources

Packer Examples for VMware vSphere