Skip to content

Commit d46902b

Browse files
committed
Prep for open sourcing
* Added a CONTRIBUTING file. This is boilerplate. * The License file is basically the same, but has an appendix and possibly some spacing differences. The open source publishing tooling requires that we use a particular exact copy of the license and not have diffs. * Fixed links from EAP, etc. * Configured blunderbuss to assign us issues and branch protection to enforce code reviews. These are boilerplate Change-Id: I05bff699f349b465523522ebeddaa52deac0baeb
1 parent fc52541 commit d46902b

File tree

6 files changed

+307
-61
lines changed

6 files changed

+307
-61
lines changed

.github/blunderbuss.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
assign_issues:
15+
- googleworkspace/teams/edu
16+
assign_prs:
17+
- googleworkspace/teams/edu

.github/sync-repo-settings.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# See https://github.com/googleapis/repo-automation-bots/tree/main/packages/sync-repo-settings for app options.
16+
rebaseMergeAllowed: true
17+
squashMergeAllowed: true
18+
mergeCommitAllowed: false
19+
deleteBranchOnMerge: true
20+
branchProtectionRules:
21+
- pattern: main
22+
isAdminEnforced: false
23+
requiresStrictStatusChecks: false
24+
requiredStatusCheckContexts:
25+
# .github/workflows/test.yml with a job called "test"
26+
- "test"
27+
# .github/workflows/lint.yml with a job called "lint"
28+
- "lint"
29+
# Google apps below
30+
- "cla/google"
31+
- "snippet-bot check"
32+
- "header-check"
33+
- "conventionalcommits.org"
34+
requiredApprovingReviewCount: 1
35+
requiresCodeOwnerReviews: true
36+
permissionRules:
37+
- team: edu
38+
permission: admin

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Ignore all folders beginning with '.'; this will ignore many local config files for most IDEs.
22
.*/
3+
!.github
4+
!.sync-repo-settings.yaml
35

46
# Ignore any VS Code workspace files.
57
*.code-workspace

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# How to Contribute
2+
3+
We would love to accept your patches and contributions to this project.
4+
5+
## Before you begin
6+
7+
### Sign our Contributor License Agreement
8+
9+
Contributions to this project must be accompanied by a
10+
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
11+
You (or your employer) retain the copyright to your contribution; this simply
12+
gives us permission to use and redistribute your contributions as part of the
13+
project.
14+
15+
If you or your current employer have already signed the Google CLA (even if it
16+
was for a different project), you probably don't need to do it again.
17+
18+
Visit <https://cla.developers.google.com/> to see your current agreements or to
19+
sign a new one.
20+
21+
### Review our Community Guidelines
22+
23+
This project follows [Google's Open Source Community
24+
Guidelines](https://opensource.google/conduct/).
25+
26+
## Contribution process
27+
28+
1. Submit an issue describing your proposed change to the repository in question.
29+
1. The repository owner will respond to your issue promptly.
30+
1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
31+
1. Fork the desired repository, develop and test your code changes.
32+
1. Ensure that your code adheres to the existing style of the sample.
33+
1. Submit a pull request!
34+
35+
### Code Reviews
36+
37+
All submissions, including submissions by project members, require review. We
38+
use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests)
39+
for this purpose.

0 commit comments

Comments
 (0)