Skip to content

Update CONTRIBUTING.md #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 10, 2017
Merged

Update CONTRIBUTING.md #50

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c9df0f
Update CONTRIBUTING.md
May 8, 2017
5918b74
Update license
May 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -19,20 +20,22 @@ 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

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
#
# http://www.apache.org/licenses/LICENSE-2.0

#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Expand All @@ -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.