Skip to content

Latest commit

 

History

History
154 lines (109 loc) · 6.11 KB

CONTRIBUTING.md

File metadata and controls

154 lines (109 loc) · 6.11 KB
Raw

Contributing Guidelines

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

The Service Binding project is a community lead effort. A bi-weekly working group call is open to the public. Discussions occur here on GitHub and on the #bindings-discuss channel in the Kubernetes Slack.

There are multiple Git repositories under the servicebinding GitHub organization.

If you catch an error, please let us know by opening an issue or pull request in the related GitHub repository.

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.

Sign Your Work

Contributions to this project should conform to the Developer Certificate of Origin. You need to sign-off your git commits before sending the pull requests. The sign-off is a single line of text at the end of the commit message. The signature consists of your official name and email address. These two details should match with the name and email address used in the Git commit. All your commits need to be signed. Your signature certifies that you wrote the patch or otherwise have the right to contribute the material. The rules are pretty simple, if you can certify the below (from developercertificate.org):

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Then you just add a line to every git commit message:

Signed-off-by: Joe Smith <[email protected]>

Use your real name (sorry, no pseudonyms or anonymous contributions.)

If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s.

Note: If your git config information is set properly then viewing the git log information for your commit will look something like this:

Author: Joe Smith <[email protected]>
Date:   Thu Feb 2 11:41:15 2018 -0800

    Update README

    Signed-off-by: Joe Smith <[email protected]>

Notice the Author and Signed-off-by lines match. If they don't your PR will be rejected by the automated DCO check.

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 main branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on main; git checkout -b my-bug-fix upstream/main (Here upstream is alias for the remote repo)
  • Make commits of logical units
  • Make sure your commit messages are in the proper format. Also include any related GitHub issue references in the commit message.
  • 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/servicebinding/<repo>.git
git fetch upstream
git checkout -b my-bug-fix upstream/main
git commit -a
git push origin my-bug-fix

Staying in sync with upstream

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

git checkout my-bug-fix
git fetch upstream
git rebase upstream/main
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.