Skip to content
This repository has been archived by the owner on Jun 26, 2024. It is now read-only.

Latest commit

 

History

History
322 lines (242 loc) · 11 KB

CONTRIBUTING.md

File metadata and controls

322 lines (242 loc) · 11 KB
Raw

How to Contribute

👍🎉 First off, thanks for taking the time to contribute!

You can look at the issues with help wanted label for items that you can work on.

If you need help, please feel free to reach out to our slack channel!

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. Small pull requests are easy to review and merge. So, please send small pull requests.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Contributions to this project should conform to the Developer Certificate of Origin. See the next section for more details.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.

Getting Started

  • Fork the repository on GitHub
  • Read the README file for build and test instructions
  • Run the examples
  • Explore the project
  • Submit issues and feature requests, submit changes, bug fixes, new features

How Can I Contribute?

Reporting Bugs

Bugs are tracked as GitHub issues. Before you log a new bug, review the existing bugs to determine if the problem that you are seeing has already been reported. If the problem has not already been reported, then you may log a new bug.

Please describe the problem fully and provide information so that the bug can be reproduced. Document all the steps that were performed, the environment used, include screenshots, logs, and any other information that will be useful in reproducing the bug.

These are few commonly used labels for issues:

  • kind/documentation: documentation issue
  • kind/enhancement: feature request
  • kind/bug: SBO’s behavior is not what was expected (or documented)
  • kind/question: how do I do $X with SBO?

Suggesting Enhancements

Enhancements and requests for new features are also tracked as GitHub issues or Enhancement Proposals

As is the case with bugs, review the existing feature requests before logging a new request.

Pull Requests

All submitted code and document changes are reviewed by the project maintainers through pull requests.

To submit a bug fix or enhancement, log an issue in github, create a new branch in your fork of the repo and include the issue number as a prefix in the name of the branch. Include new tests to provide coverage for all new or changed code. Create a pull request when you have completed code changes. Include an informative title and full details on the code changed/added in the git commit message and pull request description.

Before submitting the pull request, verify that all existing tests run cleanly.

Be sure to run yamllint on all yaml files included in pull requests. Ensure that all text in files in pull requests is compliant with: .editorconfig

Each Pull Request is expected to meet the following expectations around:

Pull request description

Include a link to the issue being addressed, but describe the context for the reviewer

  • If there is no issue, consider whether there should be one:
    • New functionality must be designed and approved, may require a TEP
    • Bugs should be reported in detail
  • If the template contains a checklist, it should be checked off
  • Release notes filled in for user visible changes (bugs + features), or removed if not applicable (refactoring, updating tests) (may be enforced via the release-note Prow plugin)

Commits

  • Use the body to explain what and why vs. how. Link to an issue whenever possible and aim for 2 paragraphs, e.g.:
    • What is the problem being solved?
    • Why is this the best approach?
    • What other approaches did you consider?
    • What side effects will this approach have?
    • What future work remains to be done?
  • Prefer one commit per PR. For multiple commits ensure each makes sense without the context of the others.
  • As much as possible try to stick to these general formatting guidelines:
    • Separate subject line from message body.
    • Write the subject line using the "imperative mood" (see examples).
    • Keep the subject to 50 characters or less.
    • Try to keep the message wrapped at 72 characters.
    • Check these seven best practices for more detail.

Example Commit Message

Here's a commit message example to work from that sticks to the spirit of the guidance outlined above:

Add example commit message to demo our guidance

Prior to this message being included in our standards there was no
canonical example of an "ideal" commit message for devs to quickly copy.

Providing a decent example helps clarify the intended outcome of our
commit message rules and offers a template for people to work from. We
could alternatively link to good commit messages in our repos but that
requires developers to follow more links rather than just showing
what we want.

Docs

  • Include AsciiDoc doc updates for user visible features
  • We use Antora framework for AsciiDoc rendering
  • Spelling and grammar should be correct
  • Try to make formatting look as good as possible (use preview mode to check, i.e. render the content locally using make site)
  • Should explain thoroughly how the new feature works
  • If possible, in addition to code snippets, include a reference to an end to end example
  • Ensure that all links and references are valid

Functionality

It should be safe to cut a release at any time, i.e. merging this PR should not put us into an unreleasable state

Code

  • Reviewers are expected to understand the changes well enough that they would feel confident saying the understand what is changing and why:
    • Read through all the code changes
    • Read through linked issues and pull requests, including the discussions
  • Prefer small well factored packages with unit tests
  • Go Code Review comments
    • All public functions and attributes have docstrings
    • Don’t panic
    • Error strings are not capitalized
    • Handle all errors (gracefully)
      • When returning errors, add more context with fmt.Errorf and %v
    • Use meaningful package names (avoid util, helper, lib)
    • Prefer short variable names

Tests

  • New features (and often/whenever possible bug fixes) have one or all of:
    • Unit tests
    • End to end, i.e. acceptance tests
  • Unit tests:
    • Coverage should remain the same or increase

Configure your local environment

To compile and execute the Service Binding Operator, you must have on your machine the following dependencies:

  • Git
  • Go
  • Python3
  • Make
  • Docker

Other dependencies are needed, but you can install them locally using the make rule install-tools. This rule will download into the local ./bin folder all the missing tools needed to work with this repo. So, to install the dependencies locally and configure your shell to use them, use the following commands:

make install-tools
eval $(make local-env)

If not present, the following dependencies will be downloaded:

  • minikube
  • opm
  • mockgen
  • kubectl-slice
  • yq
  • kustomize
  • controller-gen
  • gen-mocks
  • operator-sdk
  • kubectl
  • helm

Running Acceptance Tests

  1. Install dependencies
make install-tools
eval $(make local-env)
  1. Set KUBECONFIG for both minikube and acceptance tests (it will be generated at minikube's start if it does not exist):
export KUBECONFIG=/tmp/minikubeconfig
  1. Start minikube:
./hack/start-minikube.sh
  1. Enable olm on minikube:
minikube addons enable olm
  1. Deploy operator to the minikube cluster
eval $(minikube docker-env)
make deploy OPERATOR_REPO_REF=$(minikube ip):5000/sbo
  1. Execute all acceptance tests tagged with @dev using kubectl CLI:
make test-acceptance TEST_ACCEPTANCE_TAGS="@dev" TEST_ACCEPTANCE_START_SBO=remote TEST_ACCEPTANCE_CLI=kubectl

To run a specific test:

make test-acceptance TEST_ACCEPTANCE_START_SBO=remote TEST_ACCEPTANCE_CLI=kubectl EXTRA_BEHAVE_ARGS='-n "Specify path of secret in the Service Binding"'

Pull Request Workflow

  • Fork the repository and clone it your work directory
  • Create a topic branch from where you want to base your work
    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on master; git checkout -b my-bug-fix upstream/master (Here upstream is alias for the remote repo)
  • Make commits of logical units
  • Make sure your commit messages are in the proper format.
  • Push your changes to a topic branch in your fork of the repository
  • Submit a pull request

Example:

git remote add upstream https://github.com/kubepreset/kubepreset.git
git fetch upstream
git checkout -b my-bug-fix upstream/master
git commit -s
git push origin my-bug-fix

Staying in sync with upstream

When your branch gets out of sync with the upstream/master branch, use the following to update:

git checkout my-bug-fix
git fetch upstream
git rebase upstream/master
git push --force-with-lease origin my-bug-fix

Updating pull requests

If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into existing commits.

If your pull request contains a single commit or your changes are related to the most recent commit, you can simply amend the commit.

git add .
git commit --amend
git push --force-with-lease origin my-bug-fix

If you need to squash changes into an earlier commit, you can use:

git add .
git commit --fixup <commit>
git rebase -i --autosquash main
git push --force-with-lease origin my-bug-fix

Please add a comment in the PR indicating your new changes are ready to review.