Skip to content

Commit ea14b86

Browse files
authored
Update CONTRIBUTING.md (#50)
1 parent f08061f commit ea14b86

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Contributing to the Optimizely Python SDK
2+
23
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.
34

45
## Development process
56

6-
1. Create a branch off of `devel`: `git checkout -b YOUR_NAME/branch_name`.
7+
1. Create a branch off of `master`: `git checkout -b YOUR_NAME/branch_name`.
78
2. Commit your changes. Make sure to add tests!
8-
3. Lint your changes before submitting with `pep8 YOUR_CHANGED_FILES.py`.
9+
3. Lint your changes before submitting: `pep8 YOUR_CHANGED_FILES.py`.
910
4. `git push` your changes to GitHub.
10-
5. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `devel`.
11-
6. Open a pull request from `YOUR_NAME/branch_name` to `devel`.
12-
7. A repository maintainer will review your pull request and, if all goes well, merge it!
11+
5. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`.
12+
6. Open a pull request from `YOUR_NAME/branch_name` to `master`.
13+
7. A repository maintainer will review your pull request and, if all goes well, squash and merge it!
1314

1415
## Pull request acceptance criteria
1516

@@ -19,20 +20,22 @@ We welcome contributions and feedback! All contributors must sign our [Contribut
1920
* Lint your code with PEP-8 before submitting.
2021

2122
## Style
23+
2224
We enforce PEP-8 rules with a few minor deviations.
2325

2426
## License
2527

2628
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:
2729

2830
```
29-
# Copyright 2017, Optimizely
31+
# Copyright YEAR, Optimizely, Inc. and contributors
32+
#
3033
# Licensed under the Apache License, Version 2.0 (the "License");
3134
# you may not use this file except in compliance with the License.
3235
# You may obtain a copy of the License at
3336
#
3437
# http://www.apache.org/licenses/LICENSE-2.0
35-
38+
#
3639
# Unless required by applicable law or agreed to in writing, software
3740
# distributed under the License is distributed on an "AS IS" BASIS,
3841
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -43,4 +46,5 @@ All contributions are under the CLA mentioned above. For this project, Optimizel
4346
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”.
4447

4548
## Contact
49+
4650
If you have questions, please contact developers@optimizely.com.

0 commit comments

Comments
 (0)