8000 Update CONTRIBUTING and AUTHORING_GUIDE with submission and review gu… · orossini/python-docs-samples@a913506 · GitHub
[go: up one dir, main page]

Skip to content

Commit a913506

Browse files
authored
Update CONTRIBUTING and AUTHORING_GUIDE with submission and review guidelines (GoogleCloudPlatform#7041)
1 parent 2038be9 commit a913506

File tree

3 files changed

+25
-16
lines changed

3 files changed

+25
-16
lines changed

.github/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
66

77

8+
# Prefer GitHub teams over individuals to make it easier to find a suitable owner
9+
# when someone is OOO or leaves the team.
10+
811
# The python-samples-owners team is the default owner for anything not
912
# explicitly taken by someone else.
1013
* @GoogleCloudPlatform/python-samples-owners

AUTHORING_GUIDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ owner to review your code for product-specific needs.
4646
In **library repositories** with pre-existing samples GitHub will automatically assign a reviewer
4747
from python-samples-owners. If no reviewer is automatically assigned, contact [@googleapis/python-samples-owners](https://github.com/orgs/googleapis/teams/python-samples-owners).
4848

49-
Feel free to reach out to your assigned reviewer if it's been a few days and you haven't gotten a response!
49+
Please reach out to your assigned reviewer if it's been more than 2 days and you haven't gotten a response!
5050

5151
### How do I set up my environment?
5252

@@ -102,7 +102,7 @@ started with using a service or API — it should be in a _quickstart_ folder.
102102

103103
### Python Versions
104104

105-
Samples should support Python 3.6, 3.7, and 3.8.
105+
Samples should support Python 3.6, 3.7, 3.8, and 3.9.
106106

107107
If the API or service your sample works with has specific Python version
108108
requirements different from those mentioned above, the sample should support

CONTRIBUTING.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
11
# How to become a contributor and submit your own code
22

3+
Patches are always welcome!
4+
5+
If you're interested in contributing a new code sample or making large changes to existing samples,
6+
please open an issue for discussion first.
7+
8+
## Contributing A Patch
9+
10+
1. Submit an issue describing your proposed change to this repository.
11+
2. A repo owner will respond to your issue promptly. If you don't see a response within
12+
a few days, please ping the owner assignd to your issue.
13+
3. If your proposed change is accepted, and you haven't already done so, sign a
14+
Contributor License Agreement (see details above).
15+
4. Fork this repo, develop and test your code changes. Tests are required for all
16+
samples. See the [Authoring Guide](AUTHORING_GUIDE.md) for details.
17+
5. Ensure that your code adheres to the existing style in the sample to which
18+
you are contributing.
19+
6. Ensure that your code has an appropriate set of unit tests which all pass.
20+
7. Submit a pull request.
21+
322
## Contributor License Agreements
423

5-
We'd love to accept your sample apps and patches! Before we can take them, we
6-
have to jump a couple of legal hurdles.
24+
Before we can take contributions, we have to jump a couple of legal hurdles.
725

826
Please fill out either the individual or corporate Contributor License
927
Agreement (CLA).
@@ -17,18 +35,6 @@ Follow either of the two links above to access the appropriate CLA and
1735
instructions for how to sign and return it. Once we receive it, we'll
1836
be able to accept your pull requests.
1937

20-
## Contributing A Patch
21-
22-
1. Submit an issue describing your proposed change to the repo in question.
23-
1. The repo owner will respond to your issue promptly.
24-
1. If your proposed change is accepted, and you haven't already done so, sign a
25-
Contributor License Agreement (see details above).
26-
1. Fork the desired repo, develop and test your code changes.
27-
1. Ensure that your code adheres to the existing style in the sample to which
28-
you are contributing.
29-
1. Ensure that your code has an appropriate set of unit tests which all pass.
30-
1. Submit a pull request.
31-
3238
## Setting up a development environment
3339

3440
* [Mac development environment guide](MAC_SETUP.md)

0 commit comments

Comments
 (0)
0