Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 2.49 KB

Contribution Guide

First, thanks for taking the time to contribute! ❤️

Contribution Options

There are plenty of ways you can contribute to this Solutions Samples repository:

  • Help improve an existing soltion by suggeting code changes or reporting issues.
  • Suggest a new solution by submitting a pull request (use our template)
  • Help improve our documentation.
  • Anything else you think that would make this repository better.

Get Started!

Follow the instructions below to setup local KICS development environment and push your changes.

  1. Login to your GitHub account.
  2. Fork the Lyve-Cloud-solutions-samples repo on GitHub.
  3. Clone your fork locally with git clone command or parallel from your IDE.
  4. Make your changes locally (main branch or a dedicated feature branch).
  5. Push your changes to your fork with git push or parallel from your IDE.
  6. Submit a pull request on GitHub website.

Sign Your Commits

DCO

Licensing is important to open source projects. It provides some assurances that the software will continue to be available based under the terms that the author(s) desired. We require that contributors sign off on commits submitted to our project's repositories. The Developer Certificate of Origin (DCO) is a way to certify that you wrote and have the right to contribute the code you are submitting to the project.

You sign-off by adding the following to your commit messages. Your sign-off must match the git user and email associated with the commit.

This is my commit message

Signed-off-by: Your Name <your.name@example.com>

Git has a -s command line option to do this automatically:

git commit -s -m 'This is my commit message'

If you forgot to do this and have not yet pushed your changes to the remote repository, you can amend your commit with the sign-off by running

git commit --amend -s

Pull Request Checklist

When you submit your pull request, or you push new commits to it, our automated systems will run some checks on your new code. We require that your pull request passes these checks, but we also have more criteria than just that before we can accept and merge it. We recommend that you check the following things locally before you submit your code:

  • changes are tested locally
  • installation instructions exist and are up-to-date