Skip to content
This repository was archived by the owner on Jun 21, 2023. It is now read-only.

Commit 8db00a7

Browse files
authored
Update CONTRIBUTING.md (optimizely#53)
1 parent c091fc2 commit 8db00a7

File tree

1 file changed

+29
-25
lines changed

1 file changed

+29
-25
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,53 @@
1-
#Contributing to the Optimizely JavaScript SDK
1+
# Contributing to the Optimizely JavaScript SDK
22

33
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

55
## Development process
66

7-
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`.
88
2. Commit your changes. Make sure to add tests!
99
3. Run `npm run lint` to ensure there are no lint errors.
1010
4. Run `webpack` to generate the built and minified file for those not installing via `npm`
1111
5. `git push` your changes to GitHub.
12-
6. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `devel`.
13-
7. Open a pull request from `YOUR_NAME/branch_name` to `devel`.
14-
8. A repository maintainer will review your pull request and, if all goes well, merge it!
12+
6. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`.
13+
7. Open a pull request from `YOUR_NAME/branch_name` to `master`.
14+
8. A repository maintainer will review your pull request and, if all goes well, squash and merge it!
1515

16-
##Pull request acceptance criteria
16+
## Pull request acceptance criteria
1717

1818
* **All code must have test coverage.** We use Mocha's chai assertion library and Sinon. Changes in functionality should have accompanying unit tests. Bug fixes should have accompanying regression tests.
1919
* Tests are located in the `tests.js` file.
2020
* Please don't change the `package.json` or `VERSION`. We'll take care of bumping the version when we next release.
2121
* Lint your code with our `npm run lint` before submitting.
2222

23-
##Style
23+
## Style
24+
2425
To enforce style rules, we use ESLint. See our [.eslintrc.js](.eslintrc.js) for more information on our specific style rules.
2526

26-
##License
27+
## License
2728

28-
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:
29+
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:
2930

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

48-
##Contact
49+
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”.
50+
51+
## Contact
52+
4953
If you have questions, please contact developers@optimizely.com.

0 commit comments

Comments
 (0)