-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make contributing guidelines more relevant
- Remove Kubernetes SIG specific details - The text is written for all repositories. Signed-off-by: Baiju Muthukadan <baiju.m.mail@gmail.com> Co-authored-by: Arthur De Magalhaes <arthurdm@ca.ibm.com>
- Loading branch information
Showing
1 changed file
with
142 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,154 @@ | ||
| # Contributing Guidelines | ||
|
|
||
| ## Getting Started | ||
| :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: | ||
|
|
||
| We have full documentation on how to get started contributing here: | ||
| The Service Binding project is a community lead effort. A bi-weekly [working group call][working-group] is open to the public. Discussions occur here on GitHub and on the [#bindings-discuss channel in the Kubernetes Slack][slack]. | ||
|
|
||
| <!--- | ||
| If your repo has certain guidelines for contribution, put them here ahead of the general k8s resources | ||
| --> | ||
| [working-group]: https://docs.google.com/document/d/1rR0qLpsjU38nRXxeich7F5QUy73RHJ90hnZiFIQ-JJ8/edit#heading=h.ar8ibc31ux6f | ||
| [slack]: https://kubernetes.slack.com/archives/C012F2GPMTQ | ||
|
|
||
| - [Contributor License Agreement](https://git.k8s.io/community/CLA.md) Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests | ||
| - [Kubernetes Contributor Guide](https://git.k8s.io/community/contributors/guide) - Main contributor documentation, or you can just jump directly to the [contributing section](https://git.k8s.io/community/contributors/guide#contributing) | ||
| - [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet) - Common resources for existing developers | ||
| There are multiple Git repositories under the [`servicebinding` GitHub organization](https://github.com/servicebinding). | ||
|
|
||
| ## Mentorship | ||
| - [spec](https://github.com/servicebinding/spec) - The latest actively developing working copy of the spec. | ||
| - [service-binding-controller](https://github.com/servicebinding/service-binding-controller) - The reference implementation of the spec. | ||
| - [website](https://github.com/servicebinding/website) - The [servicebinding.io](https://servicebinding.io) website content. | ||
| - [conformance](https://github.com/servicebinding/conformance) - The conformace test suite. | ||
|
|
||
| - [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers! | ||
|
|
||
| ## Working Group | ||
| If you catch an error, please let us know by opening an issue or pull request in the related GitHub repository. | ||
|
|
||
| The Service Binding Specification for Kubernetes project is a community lead effort. | ||
| A bi-weekly [working group call][working-group] is open to the public. | ||
| Discussions occur here on GitHub and on the [#bindings-discuss channel in the Kubernetes Slack][slack]. | ||
| Please note we have a [code of conduct][conduct], please follow it in all your interactions with the project. | ||
|
|
||
| [working-group]: https://docs.google.com/document/d/1rR0qLpsjU38nRXxeich7F5QUy73RHJ90hnZiFIQ-JJ8/edit#heading=h.ar8ibc31ux6f | ||
| [slack]: https://kubernetes.slack.com/archives/C012F2GPMTQ | ||
| Contributions to this project should conform to the [Developer Certificate of Origin][dco]. See the [next section](#sign-your-work) for more details. | ||
|
|
||
| ## Sign Your Work | ||
|
|
||
| Contributions to this project should conform to the [Developer Certificate of Origin][dco]. 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][dco]): | ||
|
|
||
| ``` | ||
| 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 <joe.smith@example.com> | ||
|
|
||
| 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 <joe.smith@example.com> | ||
| Date: Thu Feb 2 11:41:15 2018 -0800 | ||
| Update README | ||
| Signed-off-by: Joe Smith <joe.smith@example.com> | ||
| ``` | ||
|
|
||
| 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][commit-message]. | ||
| 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: | ||
|
|
||
| ```shell | ||
| 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: | ||
|
|
||
| ``` shell | ||
| 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 | ||
| ``` | ||
|
|
||
| ## Issues | ||
| If you catch an error in the specification’s text, or if you write an | ||
| implementation, please let us know by opening an issue or pull request at our | ||
| [GitHub repository][repo]. | ||
| Please add a comment in the PR indicating your new changes are ready to review. | ||
|
|
||
| [repo]: https://github.com/servicebinding/spec | ||
| [conduct]: https://github.com/servicebinding/spec/blob/main/CODE_OF_CONDUCT.md | ||
| [dco]: http://developercertificate.org | ||
| [commit-message]: https://cbea.ms/git-commit/ |