Skip to content

Commit bf8f321

Browse files
DJ-osholtskinner
authored andcommitted
Create CONTRIBUTING.md
1 parent 835cebd commit bf8f321

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
2+
# How to contribute
3+
4+
We'd love to accept your patches and contributions to this project.
5+
6+
## Before you begin
7+
8+
### Sign our Contributor License Agreement
9+
10+
Contributions to this project must be accompanied by a
11+
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
12+
You (or your employer) retain the copyright to your contribution; this simply
13+
gives us permission to use and redistribute your contributions as part of the
14+
project.
15+
16+
If you or your current employer have already signed the Google CLA (even if it
17+
was for a different project), you probably don't need to do it again.
18+
19+
Visit <https://cla.developers.google.com/> to see your current agreements or to
20+
sign a new one.
21+
22+
### Review our community guidelines
23+
24+
This project follows
25+
[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
26+
27+
## Contribution process
28+
29+
### Code reviews
30+
31+
All submissions, including submissions by project members, require review. We
32+
use GitHub pull requests for this purpose. Consult
33+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
34+
information on using pull requests.
35+
36+
### Contributor Guide
37+
38+
You may follow these steps to contribute:
39+
40+
1. **Fork the official repository.** This will create a copy of the official repository in your own account.
41+
2. **Sync the branches.** This will ensure that your copy of the repository is up-to-date with the latest changes from the official repository.
42+
3. **Work on your forked repository's feature branch.** This is where you will make your changes to the code.
43+
4. **Commit your updates on your forked repository's feature branch.** This will save your changes to your copy of the repository.
44+
5. **Submit a pull request to the official repository's main branch.** This will request that your changes be merged into the official repository.
45+
6. **Resolve any linting errors.** This will ensure that your changes are formatted correctly.
46+
47+
Here are some additional things to keep in mind during the process:
48+
49+
- **Test your changes.** Before you submit a pull request, make sure that your changes work as expected.
50+
- **Be patient.** It may take some time for your pull request to be reviewed and merged.
51+
52+
---
53+
54+
## For Google Employees
55+
56+
Complete the following steps to register your GitHub account and be added as a contributor to this repository.
57+
58+
1. Register your GitHub account at [go/GitHub](http://go/github)

0 commit comments

Comments
 (0)