Skip to content

Commit b8ca720

Browse files
committed
add contribution documents
1 parent 9686e7c commit b8ca720

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
dist/
2+
myenv/
23
__pycache__/
34
.DS_Store
5+
.pytest_cache

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Contributor License Agreement
7+
8+
Contributions to this project must be accompanied by a Contributor License
9+
Agreement. You (or your employer) retain the copyright to your contribution;
10+
this simply gives us permission to use and redistribute your contributions as
11+
part of the project. Head over to <https://cla.developers.google.com/> to see
12+
your current agreements on file or to sign a new one.
13+
14+
You generally only need to submit a CLA once, so if you've already submitted one
15+
(even if it was for a different project), you probably don't need to do it
16+
again.
17+
18+
## Code reviews
19+
20+
All submissions, including submissions by project members, require review. We
21+
use GitHub pull requests for this purpose. Consult
22+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23+
information on using pull requests.
24+
25+
## Testing
26+
27+
Please make sure that your PR passes all tests by running `pytest ./src/` on your
28+
local machine. Also, you can run only tests that are affected by your code
29+
changes, but you will need to select them manually.
30+
31+
## Community Guidelines
32+
33+
This project follows [Google's Open Source Community
34+
Guidelines](https://opensource.google.com/conduct/).

0 commit comments

Comments
 (0)