-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #78 from citrix/chiradeep-contribution-update-1
Update CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
2 additions
and
109 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 |
|---|---|---|
|
|
@@ -8,112 +8,5 @@ Not every contribution comes in the form of code. Submitting, confirming, and tr | |
|
|
||
| We ask you not to submit security concerns via GitHub. For details on submitting potential security issues please see <https://support.citrix.com/article/CTX081743> | ||
|
|
||
| ## Contribution Process | ||
|
|
||
| We have a 3 step process for contributions: | ||
|
|
||
| 1. Commit changes to a git branch, making sure to sign-off those changes for the [Developer Certificate of Origin](#developer-certification-of-origin-dco). | ||
| 2. Create a GitHub Pull Request for your change. All pull requests must have at least unit test coverage. | ||
| 3. Perform a [Code Review](#code-review-process) with the project maintainers on the pull request. | ||
|
|
||
|
|
||
| ### Code Review Process | ||
|
|
||
| Code review takes place in GitHub pull requests. See [this article](https://help.github.com/articles/about-pull-requests/) if you're not familiar with GitHub Pull Requests. | ||
|
|
||
| Once you open a pull request, project maintainers will review your code and respond to your pull request with any feedback they might have. Your change will be merged into the project's `master` branch | ||
|
|
||
|
|
||
| ### Developer Certification of Origin (DCO) | ||
|
|
||
| Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired. | ||
|
|
||
| This project uses [the Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0) to strike a balance between open contribution and allowing you to use the software however you would like to. | ||
|
|
||
| The license tells you what rights you have that are provided by the copyright holder. It is important that the contributor fully understands what rights they are licensing and agrees to them. Sometimes the copyright holder isn't the contributor, such as when the contributor is doing work on behalf of a company. | ||
|
|
||
| To make a good faith effort to ensure these criteria are met, we require the Developer Certificate of Origin (DCO) process to be followed. | ||
|
|
||
| The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a Signed-off-by statement and thereby agrees to the DCO, which you can find below or at <http://developercertificate.org/>. | ||
|
|
||
| ``` | ||
| 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. | ||
| ``` | ||
|
|
||
|
|
||
| #### DCO Sign-Off Methods | ||
|
|
||
| The DCO requires a sign-off message in the following format appear on each commit in the pull request: | ||
|
|
||
| ``` | ||
| Signed-off-by: Ann Developer <[email protected]> | ||
| ``` | ||
|
|
||
| The DCO text can either be manually added to your commit body, or you can add either **-s** or **--signoff** to your usual git commit commands. If you forget to add the sign-off you can also amend a previous commit with the sign-off by running **git commit --amend -s**. If you've pushed your changes to GitHub already you'll need to force push your branch after this with **git push -f**. | ||
|
|
||
| ### Obvious Fix Policy | ||
|
|
||
| Small contributions, such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted without signing the contribution for the DCO. | ||
|
|
||
| As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. Assuming the change does not affect functionality, some common obvious fix examples include the following: | ||
|
|
||
| - Spelling / grammar fixes | ||
| - Typo correction, white space and formatting changes | ||
| - Comment clean up | ||
| - Bug fixes that change default return values or error codes stored in constants | ||
| - Adding logging messages or debugging output | ||
| - Changes to 'metadata' files like .gitignore, build scripts, etc. | ||
| - Moving source files from one directory or package to another | ||
|
|
||
| **Whenever you invoke the "obvious fix" rule, please say so in your commit message:** | ||
|
|
||
| ``` | ||
| ------------------------------------------------------------------------ | ||
| commit 370adb3f82d55d912b0cf9c1d1e99b132a8ed3b5 | ||
| Author: Ann Developer <[email protected]> | ||
| Date: Tue Oct 2 10:38:10 2018 +0530 | ||
| Fix typo in the README. | ||
| Obvious fix. | ||
| ------------------------------------------------------------------------ | ||
| ``` | ||
|
|
||
| ## Releases | ||
|
|
||
| Version numbering roughly follows [Semantic Versioning](http://semver.org/) standard. Our standard version numbers look like X.Y.Z which mean: | ||
|
|
||
| - X is a major release, which may not be fully compatible with prior major releases | ||
| - Y is a minor release, which adds both new features and bug fixes | ||
| - Z is a patch release, which adds just bug fixes | ||
|
|
||
| After shipping a release of the driver we bump the `Minor` version by one to start development of the next minor release. | ||
|
|
||
| ## Acknowledgements | ||
| This document borrows heavily from the [CONTRIBUTING.md](https://github.com/chef/chef/blob/master/CONTRIBUTING.md) from the Chef project. | ||
| ## Code Contribution | ||
| For the time being we are suspending the ability to contribute code to this project. Please raise an issue if you would like a feature to be committed to this driver | ||