Skip to content

Latest commit

 

History

History
49 lines (41 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

49 lines (41 loc) · 2.46 KB
Raw

Contribution Guidelines

Thank you for your interest in helping us improve the project! The following set of guidelines will help you get started.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

IBMers Contributing

If you are an IBMer, complete these steps, before contributing to any open source project:

  1. Complete your yearly training.
  2. Map your identity using IBM's GitHub mapper tool. This will generate an email and invite you to join the IBM org on Github.
  3. Get your manager’s approval.

You can find out more at W3 Developer.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

    Developer Certificate of Origin

    This repository uses a modified Developer Certificate of Origin (DCO) 1.1 and use a "sign-off" procedure on patches that are being emailed around or contributed in any other way.

    Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

    This is my commit message

Signed-off-by: Random J Developer <random@developer.>example.org>

    Git even has a -s command line option to append this automatically to your commit message:

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

    Fixing Commit Messages

    If you've pushed a commit and forgot to sign it, fear not, >you can sign it as follows:

    git commit --amend -s

    Modify the commit message (if desired) -- do not modify the Signed-off-by line. Exit edit mode (esc followed by :x and then Enter).