Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 2.06 KB
Raw

Contributing to Kruize

Thank you for your interest in the Kruize Project! We welcome your contributions to the project.

Submitting a contribution to Kruize HPO

HPO Project is Apache 2.0 licensed and uses GitHub to manage reviews of pull requests. This document outlines the contribution workflow, commit message formatting, contact details and other resources to make it easier to get your contribution accepted.

Contribution work flow

These steps outline the general contribution workflow:

  • Fork and set up the Hpo repository on your workstation
  • Create a topic branch from where you want to base your work (usually master)
  • Follow coding guidelines while making code changes
  • Install the required software to build and deploy hpo
  • Make sure the tests pass, add any new tests if appropriate (see HPO tests)
  • 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 to the original repository
  • Ensure the PR checks pass
  • Have any queries, contact us on kruize slack

If this is your first pull request on github, click here to quickly get started.

Commit Message

We use GPG keys for signing the commits. Refer generating a new GPG key for details. The commit message should indicate what has changed and why the change was made. Sign off on your commit in the footer. By doing this, you assert original authorship of the commit and that you are permitted to contribute it. This can be automatically added to your commit by passing -S to git commit, or by manually adding the following line to the footer of the commit.

Signed-off-by: Full Name <email>

Thank you for contributing!