Skip to content

Commit

Permalink
Prep for open sourcing
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
DavidScales committed May 3, 2024
1 parent fc52541 commit d46902b
Show file tree
Hide file tree
Showing 6 changed files with 307 additions and 61 deletions.
17 changes: 17 additions & 0 deletions .github/blunderbuss.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
assign_issues:
- googleworkspace/teams/edu
assign_prs:
- googleworkspace/teams/edu
38 changes: 38 additions & 0 deletions .github/sync-repo-settings.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# See https://github.com/googleapis/repo-automation-bots/tree/main/packages/sync-repo-settings for app options.
rebaseMergeAllowed: true
squashMergeAllowed: true
mergeCommitAllowed: false
deleteBranchOnMerge: true
branchProtectionRules:
- pattern: main
isAdminEnforced: false
requiresStrictStatusChecks: false
requiredStatusCheckContexts:
# .github/workflows/test.yml with a job called "test"
- "test"
# .github/workflows/lint.yml with a job called "lint"
- "lint"
# Google apps below
- "cla/google"
- "snippet-bot check"
- "header-check"
- "conventionalcommits.org"
requiredApprovingReviewCount: 1
requiresCodeOwnerReviews: true
permissionRules:
- team: edu
permission: admin
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Ignore all folders beginning with '.'; this will ignore many local config files for most IDEs.
.*/
!.github
!.sync-repo-settings.yaml

# Ignore any VS Code workspace files.
*.code-workspace
Expand Down
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# How to Contribute

We would love to accept your patches and contributions to this project.

## Before you begin

### Sign our Contributor License Agreement

Contributions to this project must be accompanied by a
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
You (or your employer) retain the copyright to your contribution; this simply
gives us permission to use and redistribute your contributions as part of the
project.

If you or your current employer have already signed the Google CLA (even if it
was for a different project), you probably don't need to do it again.

Visit <https://cla.developers.google.com/> to see your current agreements or to
sign a new one.

### Review our Community Guidelines

This project follows [Google's Open Source Community
Guidelines](https://opensource.google/conduct/).

## Contribution process

1. Submit an issue describing your proposed change to the repository in question.
1. The repository owner will respond to your issue promptly.
1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
1. Fork the desired repository, develop and test your code changes.
1. Ensure that your code adheres to the existing style of the sample.
1. Submit a pull request!

### Code Reviews

All submissions, including submissions by project members, require review. We
use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests)
for this purpose.
Loading

0 comments on commit d46902b

Please sign in to comment.