From 5c9df0f2e4af9b805d606eebf2dbe16b5c6859d8 Mon Sep 17 00:00:00 2001 From: Elliot Kim Date: Mon, 8 May 2017 23:34:41 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b6f8c2ba..d46b615e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,16 @@ # Contributing to the Optimizely Python SDK + We welcome contributions and feedback! All contributors must sign our [Contributor License Agreement (CLA)](https://docs.google.com/a/optimizely.com/forms/d/e/1FAIpQLSf9cbouWptIpMgukAKZZOIAhafvjFCV8hS00XJLWQnWDFtwtA/viewform) to be eligible to contribute. Please read the [README](README.md) to set up your development environment, then read the guidelines below for information on submitting your code. ## Development process -1. Create a branch off of `devel`: `git checkout -b YOUR_NAME/branch_name`. +1. Create a branch off of `master`: `git checkout -b YOUR_NAME/branch_name`. 2. Commit your changes. Make sure to add tests! -3. Lint your changes before submitting with `pep8 YOUR_CHANGED_FILES.py`. +3. Lint your changes before submitting: `pep8 YOUR_CHANGED_FILES.py`. 4. `git push` your changes to GitHub. -5. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `devel`. -6. Open a pull request from `YOUR_NAME/branch_name` to `devel`. -7. A repository maintainer will review your pull request and, if all goes well, merge it! +5. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`. +6. Open a pull request from `YOUR_NAME/branch_name` to `master`. +7. A repository maintainer will review your pull request and, if all goes well, squash and merge it! ## Pull request acceptance criteria @@ -19,6 +20,7 @@ We welcome contributions and feedback! All contributors must sign our [Contribut * Lint your code with PEP-8 before submitting. ## Style + We enforce PEP-8 rules with a few minor deviations. ## License @@ -26,7 +28,8 @@ We enforce PEP-8 rules with a few minor deviations. All contributions are under the CLA mentioned above. For this project, Optimizely uses the Apache 2.0 license, and so asks that by contributing your code, you agree to license your contribution under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). Your contributions should also include the following header: ``` -# Copyright 2017, Optimizely +# Copyright YEAR, Optimizely, Inc. and contributors +# # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -43,4 +46,5 @@ All contributions are under the CLA mentioned above. For this project, Optimizel The YEAR above should be the year of the contribution. If work on the file has been done over multiple years, list each year in the section above. Example: Optimizely writes the file and releases it in 2014. No changes are made in 2015. Change made in 2016. YEAR should be “2014, 2016”. ## Contact + If you have questions, please contact developers@optimizely.com.