Contributing

Growing our open source

We're always open to accepting patches, feature upgrades, and adapters that can make our open source software better. To make contributions, there are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to Spruce's OS projects must be accompanied by a Contributor License Agreement. We use https://cla-assistant.io/ to verify and sign CLAs for each PR. (Don't worry about signing a CLA just for documentation bugs and requests, those are not licensed the same way as our software releases).

By signing a "CLA", you (and/or your employer) retain all copyrights to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project and, if necessary, update the project's licensing without having to track down all contributors for explicit consent.

Please check with your employer, counsel, or HR staff if you have any questions about what you are signing or on whose behalf. Do not sign an individual CLA unless you are certain it does not contradict a pre-existing contract with your employer.

If you have any questions, or if you would like to sign a CLA for your Github organization, please reach out to: oss@spruceid.com.

Code Reviews

All submissions, including submissions by full-time Spruce employees, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests. You may tag outside reviewers, but a review by Spruce is still the condition of acceptance.

Code of Conduct

All our OS projects follow Spruce's overall Code of Conduct.

Last updated