Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 3.41 KB

CONTRIBUTING_DCO.md

File metadata and controls

74 lines (48 loc) · 3.41 KB
Raw

Contributing to hci-benchmark-appliance

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 hci-benchmark-appliance, 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.

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

  • Getting familiar with HCIBench code structure
  1. prepare an vSphere environment or VMware workstation/fusion to host HCIBench VM.
  2. Download and deploy HCIBench ova from Releases.
  3. SSH into HCIBench, and explore the following paths: /root/tmp /opt/automation /opt/vmware/rvc

  • Getting familiar with the code

    1. Look at the upgrade.sh to know how the code is deployed into HCIBench
    2. Mosts HCIBench functions are wrapped within this lib folder

  • Test your code after you contribute some changes to the code, put the code into HCIBench VM running in your environment and run a HCIBench test to validate your change.

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. Check if your code changes will pass both code linting checks and unit tests.
  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

For specifics on what to include in your report, please follow the guidelines in the issue and pull request templates when available.

Ask for Help

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

  • The original GitHub issue
  • The developer mailing list
  • Our Slack channel

Additional Resources