Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

61 lines (39 loc) · 2.7 KB
Raw

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.

Found a bug?

If you've discovered a bug you can submit an issue, or skip straight to creating a pull request 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 or just create a pull request if your feature is already implemented.

Large - Please detail an issue 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. This is required for us to accept your changes.
  3. Fork 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
  1. Ensure all tests pass when running go test ./... from the root of your forked repository.
  2. Rebase your branch to our main and push
git remote add upstream git@github.com:progressive-insurance/need-cla.git
git fetch upstream
git rebase upstream/main
git push --force-with-lease
  1. Create a pull request 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)