Skip to content

Latest commit

 

History

History
133 lines (94 loc) · 4.96 KB

CONTRIBUTING.md

File metadata and controls

133 lines (94 loc) · 4.96 KB
Raw

Contributing to Openkruise

Welcome to Openkruise! Openkruise consists several repositories under the organization. We encourage you to help out by reporting issues, improving documentation, fixing bugs, or adding new features. Please also take a look at our code of conduct, which details how contributors are expected to conduct themselves as part of the Openkruise community.

Reporting issues

To be honest, we regard every user of Openkruise as a very kind contributor. After experiencing Openkruise, you may have some feedback for the project. Then feel free to open an issue.

There are lot of cases when you could open an issue:

  • bug report
  • feature request
  • performance issues
  • feature proposal
  • feature design
  • help wanted
  • doc incomplete
  • test improvement
  • any questions on project
  • and so on

Also we must remind that when filing a new issue, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.

Code and doc contribution

Every action to make Openkruise better is encouraged. On GitHub, every improvement for Openkruise could be via a PR (short for pull request).

  • If you find a typo, try to fix it!
  • If you find a bug, try to fix it!
  • If you find some redundant codes, try to remove them!
  • If you find some test cases missing, try to add them!
  • If you could enhance a feature, please DO NOT hesitate!
  • If you find code implicit, try to add comments to make it clear!
  • If you find code ugly, try to refactor that!
  • If you can help to improve documents, it could not be better!
  • If you find document incorrect, just do it and fix that!
  • ...

Workspace Preparation

To put forward a PR, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps:

  1. Fork Fork the repository you wish to work on. You just need to click the button Fork in right-left of project repository main page. Then you will end up with your repository in your GitHub username.
  2. Clone your own repository to develop locally. Use git clone https://github.com/<your-username>/<project>.git to clone repository to your local machine. Then you can create new branches to finish the change you wish to make.
  3. Set remote upstream to be https://github.com/openkruise/<project>.git using the following two commands:
git remote add upstream https://github.com/openkruise/<project>.git
git remote set-url --push upstream no-pushing

Note: <project> above is rollouts if you want to contribute codes to Kruise Rollout.

Adding this, we can easily synchronize local branches with upstream branches.

  1. Create a branch to add a new feature or fix issues

Update local working directory:

cd <project>
git fetch upstream
git checkout master
git rebase upstream/master

Create a new branch:

git checkout -b <new-branch>

Make any change on the new-branch then build and test your codes.

PR Description

PR is the only way to make change to project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the PR template to finish the pull request.

Developing Environment

As a contributor, if you want to make any contribution to Kruise project, we should reach an agreement on the version of tools used in the development environment. Here are some dependents with specific version:

  • Golang : v1.18+
  • Kubernetes: v1.19+

Developing guide

There's a Makefile in the root folder which describes the options to build and install. Here are some common ones:

# Generate code and manifests e.g. CRD, RBAC YAML files etc, and build the controller manager binary
make build

# Run the unit tests
make test

There are some guide documents for contributors in ./docs/contributing/, such as debug guide to help you test your own branch in a Kubernetes cluster.

Proposals

If you are going to contribute a feature with new API or needs significant effort, please submit a proposal in ./docs/proposals/ first.

Engage to help anything

We choose GitHub as the primary place for Openkruise to collaborate. So the latest updates of Openkruise are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.

  • reply to other's issues if you could;
  • help solve other user's problems;
  • help review other's PR design;
  • help review other's codes in PR;
  • discuss about Openkruise to make things clearer;
  • advocate Openkruise technology beyond GitHub;
  • write blogs on Openkruise and so on.

In a word, ANY HELP IS CONTRIBUTION.

Join Openkruise as a member

It is also welcomed to join Openkruise team if you are willing to participate in Openkruise community continuously and keep active. Please read and follow the Community Membership.