Skip to content

Commit 895dbc7

Browse files
authored
chore: Add CONTRIBUTING.md (#230)
Add a CONTRIBUTING.md file with basic instructions for contributors to Go SDK
1 parent b5b5433 commit 895dbc7

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to the Optimizely Go SDK
2+
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.
4+
5+
## Development process
6+
7+
1. Fork the repository and create your branch from master.
8+
2. Please follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) for each commit message.
9+
3. Make sure to add tests!
10+
4. Ensure lint check and tests are passing: `make lint`, `make test`
11+
5. Push a branch with your changes to GitHub.
12+
6. Open a PR from your fork into the master branch of the original repo
13+
9. A repository maintainer will review your pull request and, if all goes well, squash and merge it!
14+
15+
## Pull request acceptance criteria
16+
17+
**All code must have test coverage.** Changes in functionality should have accompanying unit tests. Bug fixes should have accompanying regression tests.
18+
19+
## License
20+
21+
All contributions are under the CLA mentioned above.
22+
23+
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).
24+
25+
Your contributions should also include the following header:
26+
```
27+
/****************************************************************************
28+
* Copyright YEAR, Optimizely, Inc. and contributors *
29+
* *
30+
* Licensed under the Apache License, Version 2.0 (the "License"); *
31+
* you may not use this file except in compliance with the License. *
32+
* You may obtain a copy of the License at *
33+
* *
34+
* http://www.apache.org/licenses/LICENSE-2.0 *
35+
* *
36+
* Unless required by applicable law or agreed to in writing, software *
37+
* distributed under the License is distributed on an "AS IS" BASIS, *
38+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
39+
* See the License for the specific language governing permissions and *
40+
* limitations under the License. *
41+
***************************************************************************/
42+
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 2018. No changes are made in 2019. Change made in 2020. YEAR should be “2018, 2020”.
46+
47+
## Contact
48+
49+
If you have questions, please contact [email protected].

0 commit comments

Comments
 (0)