Skip to content

Commit 078fbb1

Browse files
authored
Update CONTRIBUTING.md (#112)
1 parent 2640de2 commit 078fbb1

File tree

1 file changed

+50
-6
lines changed

1 file changed

+50
-6
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,55 @@
1-
# optimizely-ab-android-sdk
1+
# Contributing to the Optimizely Android SDK
22

3-
## Contributing
3+
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.
44

5-
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.
5+
## Development process
66

7-
Simply create a branch off of `master`. When the work on the branch is complete make a pull request. Pull requests should be squashed and merged into `devel`.
7+
1. Create a branch off of `master`: `git checkout -b YOUR_NAME/branch_name`.
8+
2. Commit your changes. Make sure to add tests!
9+
3. `git push` your changes to GitHub.
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!
813

9-
All branches will be built and run against the entire test suite on Travis with every commit.
14+
All branches will be built and run against the entire test suite on Travis with every commit.
1015

11-
The `test-app` module is built against a real Optimizely project. Changing the project ID will cause tests to fail. The test app should be used as a reference.
16+
The `test-app` module is built against a real Optimizely project. Changing the project ID will cause tests to fail. The test app should be used as a reference.
17+
18+
## Pull request acceptance criteria
19+
20+
* **All code must have test coverage.** We use JUnit. Changes in functionality should have accompanying unit tests. Bug fixes should have accompanying regression tests.
21+
* Unit tests are located in `MODULE_NAME/src/test` and instrumented tests are located in `MODULE_NAME/src/androidTest` for each module with one file per class.
22+
* Version will be bumped automatically through Gradle after your change is merged.
23+
* Make sure `./gradlew testAllModules` runs successfully before submitting.
24+
25+
## Style
26+
27+
Refer to the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)
28+
29+
## License
30+
31+
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:
32+
33+
```
34+
/****************************************************************************
35+
* Copyright YEAR, Optimizely, Inc. and contributors *
36+
* *
37+
* Licensed under the Apache License, Version 2.0 (the "License"); *
38+
* you may not use this file except in compliance with the License. *
39+
* You may obtain a copy of the License at *
40+
* *
41+
* http://www.apache.org/licenses/LICENSE-2.0 *
42+
* *
43+
* Unless required by applicable law or agreed to in writing, software *
44+
* distributed under the License is distributed on an "AS IS" BASIS, *
45+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
46+
* See the License for the specific language governing permissions and *
47+
* limitations under the License. *
48+
***************************************************************************/
49+
```
50+
51+
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”.
52+
53+
## Contact
54+
55+
If you have questions, please contact [email protected].

0 commit comments

Comments
 (0)