initial public commit

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+<!--
+  Thank you for sending a pull request!
+  Please take a look at our contribution guide: https://github.com/progressive-insurance/need-cla/blob/main/CONTRIBUTING.md
+  One of the project maintainers will review your PR.
+-->
+
+# :eyes: Pull Request
+
+**What type of PR is this**
+
+<!-- Please check the one that applies to this PR using "x". -->
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Documentation
+- [ ] Refactor
+- [ ] Pipeline
+
+**Which issue(s) does this PR address?**
+
+<!--List issue(s) below. Use "fixes #X" or "closes #X" and the issue will close automatically when the PR is merged.-->
+
+**What does this PR do? Why do we need it?**
+
+**Does this PR include breaking changes? Does it contain changes that are not backwards-compatible?**
+
+- [ ] Yes
+- [ ] No
+
+<!-- List any changes made in this PR that aren't backwards-compatible. -->
+
+**Additional information**
+
+<!-- Include anything that would help your reviewer (e.g. screenshots). -->

.github/workflows/test.yml

@@ -0,0 +1,11 @@
+name: Run Go tests
+on: [ push, pull_request ]
+jobs: 
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-go@v2
+      with:
+        go-version: 1.16
+    - run: go test -v -short ./...

.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.prof
+profile*.png

CODEOWNERS

@@ -0,0 +1 @@
+* @justintout

CODE_OF_CONDUCT.md

@@ -0,0 +1,48 @@
+# Progressive Open Source Code of Conduct
+
+This Code of Conduct outlines expectations for participation in Progressive-managed open source communities, and steps for reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community.
+
+## Our Pledge
+
+We as members and contributors, pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, and inclusive community.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment for our community include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing opinions, viewpoints, and experiences
+- Gracefully accepting constructive feedback
+- Focusing on what is best for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and unwelcome sexual attention or advances
+- Trolling, insulting, or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or its community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by product maintainers.
+
+## Enforcement
+
+We encourage all communities to resolve issues on their own whenever possible. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers responsible for enforcement at [email protected].
+
+All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant homepage,
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# How to Contribute
+
+> NOTE: Currently, you **can't contribute** (unless you're a Progressive employee). We are in the process of finalizing our CLA (ironic) and cannot legally
+> accept contributions at this time. We are very close to completing our automated CLA workflow, so please check back soon if you're looking to contribute.
+
+We warmly welcome any community contributions to this repository.
+
+## Code of Conduct
+
+Help us ensure an inspiring, inclusive community.
+Please read our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+## Found a bug?
+
+If you've discovered a bug you can [submit an issue](https://github.com/progressive-insurance/need-cla/issues), or skip straight to [creating a pull request](#submitting-a-pr) if you already have a fix.
+
+## Want a new feature?
+
+We can't wait to hear about your new ideas.
+Please consider the size of the feature you're proposing before taking your next steps.
+
+**Small** - You can [submit an issue](https://github.com/progressive-insurance/need-cla/issues) or just [create a pull request](#submitting-a-pr) if your feature is already implemented.
+
+**Large** - Please [detail an issue](https://github.com/progressive-insurance/need-cla/issues) so that it can be discussed.
+This gives us a chance to make sure we can coordinate the changes and helps ensure the easiest path forward for your changes.
+
+## Submitting a PR
+
+1. Check for open PRs with duplicate work.
+2. [Sign our CLA](#signing-the-cla). This is **required** for us to accept your changes.
+3. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repo and make your changes in a new branch.
+
+- If adding a new feature, create a `feature/*` branch. Don't forget to add new tests!
+- If fixing a bug, create a `bug/*` branch.
+- If updating documentation, create a `docs/*` branch.
+- Use descriptive commit messages
+
+4. Ensure all tests pass when running `go test ./...` from the root of your forked repository.
+5. Rebase your branch to our `main` and push
+
+```
+git remote add upstream [email protected]:progressive-insurance/need-cla.git
+git fetch upstream
+git rebase upstream/main
+git push --force-with-lease
+```
+
+6. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) to `need-cla:main`, responding to questions/feedback on the PR until it is merged.
+
+## Signing the CLA
+
+> NOTE: We are in the process of finalizing our CLA workflow.
+> If you are attempting to contribute, please check back soon (or open an issue prodding us along!).
+
+A signed Contributor License Agreement is required before we can accept any code from you.
+
+## Maintainers
+
+This repository is maintained by:
+
+- Justin Tout (JUSTINTOUT)

LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2021-2022 Progressive Casualty Insurance Company
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,51 @@
+# need-cla
+
+[![Run Go tests](https://github.com/Progressive/need-cla/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Progressive/need-cla/actions/workflows/test.yml)
+
+> Go library and command line utility to check if a GitHub repository might need a CLA signed before contributing
+
+**Please note,** until GitHub provides an official "CLA Required" API endpoint, the best we can make are guesses.
+
+This library uses a few heuristics to determine if a repository requires a CLA:
+
+- if the repo is owned by a list of [known CLA requirers from Wikipedia](https://en.wikipedia.org/wiki/Contributor_License_Agreement#Users)
+- if the repo's `CONTRIBUTING.md` or `README.md` reference "CLA" or "Contributor License Agreement"
+- if any of the repo's workflows have a `uses: cla-assistant/github-action` line
+- if any of the most recent 100 PRs have a Google-style `cla: yes` or `cla: no` tag
+- if a `.clabot` file exists in the repo root
+
+More methods to denote CLA requirements probably exist.
+If you know of a good way to check for CLA requirements, please [contribute](./CONTRIBUTING.md)!
+
+## Library
+
+### Installation
+
+```
+go get github.com/Progressive/need-cla
+```
+
+### Usage
+
+First, import the library:
+
+```go
+import "github.com/Progressive/need-cla"
+```
+
+Then, create a GitHub client and check if a repository needs a CLA:
+
+```go
+client := github.NewClient(nil) // this typically comes from github.com/google/go-github/v38/github
+needCla, err := needcla.Check(client, "google", "go-github")
+if err != nil {
+  // handle
+}
+if needCla {
+  fmt.Println("it needs a CLA signed!")
+}
+```
+
+## `need-cla` Command Line Utility
+
+[See the executable's README.md](./cmd/need-cla/README.md)