Skip to content

Commit 4edeebf

Browse files
authored
Update CONTRIBUTING.md (#45)
1 parent eb2d81e commit 4edeebf

File tree

1 file changed

+32
-11
lines changed

1 file changed

+32
-11
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,49 @@
1-
#Contributing to the Optimizely Ruby SDK
1+
# Contributing to the Optimizely Ruby 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

4-
##Development process
5+
## 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!
89
3. `git push` your changes to GitHub.
9-
4. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `devel`.
10-
5. Open a pull request from `YOUR_NAME/branch_name` to `devel`.
11-
6. A repository maintainer will review your pull request and, if all goes well, merge it!
10+
4. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`.
11+
5. Open a pull request from `YOUR_NAME/branch_name` to `master`.
12+
6. A repository maintainer will review your pull request and, if all goes well, squash and merge it!
1213

13-
##Pull request acceptance criteria
14+
## Pull request acceptance criteria
1415

1516
* **All code must have test coverage.** We use rspec. Changes in functionality should have accompanying unit tests. Bug fixes should have accompanying regression tests.
1617
* Tests are located in `/spec` with one file per class.
1718
* Please don't change the Rakefile or VERSION. We'll take care of bumping the version when we next release.
1819
* Lint your code with our [RuboCop rules](.rubocop.yml) before submitting.
1920

20-
##Style
21+
## Style
22+
2123
To enforce style rules, we use RuboCop. See our [rubocop.yml](.rubocop.yml) for more information on our specific style rules.
2224

23-
##License
25+
## License
26+
27+
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:
28+
29+
```
30+
# Copyright YEAR, Optimizely, Inc. and contributors
31+
#
32+
# Licensed under the Apache License, Version 2.0 (the "License");
33+
# you may not use this file except in compliance with the License.
34+
# You may obtain a copy of the License at
35+
#
36+
# http://www.apache.org/licenses/LICENSE-2.0
37+
#
38+
# Unless required by applicable law or agreed to in writing, software
39+
# distributed under the License is distributed on an "AS IS" BASIS,
40+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
41+
# See the License for the specific language governing permissions and
42+
# limitations under the License.
43+
```
44+
45+
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”.
2446

25-
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).
47+
## Contact
2648

27-
##Contact
2849
If you have questions, please contact developers@optimizely.com.

0 commit comments

Comments
 (0)