Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 2.76 KB

Table of Contents generated with DocToc

Contributing guidelines

Developer Certificate of Origin

This repository built with probot that enforces the Developer Certificate of Origin (DCO) on Pull Requests. It requires all commit messages to contain the Signed-off-by line with an email address that matches the commit author.

Contributing A Patch

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owners will respond to your issue promptly.
  3. Fork the desired repo, develop and test your code changes.
  4. Commit your changes with DCO
  5. Submit a pull request.

Issue and Pull Request Management

Anyone may comment on issues and submit reviews for pull requests. However, in order to be assigned an issue or pull request, you must be a member of the IBM GitHub organization.

Repo maintainers can assign you an issue or pull request by leaving a /assign <your Github ID> comment on the issue or pull request.

Contribution flow

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

  • Create a topic branch from where to base the contribution. This is usually master.
  • Make commits of logical units.
  • Make sure commit messages are in the proper format (see below).
  • Push changes in a topic branch to a personal fork of the repository.
  • Submit a pull request to IBM/operator-deployment-lifecycle-manager.
  • The PR must receive a LGTM from two maintainers found in the MAINTAINERS file.

Thanks for contributing!

Pre-check before submitting a PR

After your PR is ready to commit, please run following commands to check your code and run the unit test.

make code-dev

Then you need to make sure it can pass the e2e test

make e2e-test-kind

Build Operator Image

Make sure your code build passed.

make build-operator-image

Build Bundle Image

You can use the following command to build the operator bundle image

make build-bundle-image