Welcome, and thank you for your interest in contributing!
The goal of this document is to provide a high-level overview of how you can contribute and explain how we accept contribution.
Please use official Snyk support website to report any issues. Our technical support team will work together with you to resolve an issue, or pass it on to our engineers for resolution.
You can find recommended information to include in the ticket on the technical support guide page.
Similarly to bug reports, we accept improvement suggestions and feedback via the official support website.
Please refer to the support knowledge base and user docs to verify that your suggestion isn't already part of our product before submitting a ticket with us.
We are thrilled that you are interested in contributing code changes! Because this project is part of Snyk’s overall software offering, we want to make sure that your contribution aligns with our vision and product strategy, so please reach out to us before submitting a pull request. If you’re thinking of contributing a new feature, contact our support with a detailed explanation of your planned contribution and we'll be happy to discuss it with you. If you’re thinking of contributing a bug fix, we’d still like you to raise a support ticket first, as it’s possible we may already be working on a fix.
Once we've confirmed that we're ready to accept your contribution, feel free to open a pull request and link it in the support ticket. We're excited to work with you to get your contribution merged and make our project even better!
As part of the PR process, you'll need to sign a Contributor License Agreement (CLA). It is an automated process and you'll only need to do it once, when contributing first time. You won't need to sign it in future when contributing to other Snyk projects.
We don't allow external contributors to run pipeline status checks on your PR for security reasons. We'll run them on your behalf when you mark your PR changes as ready for us.
Please make sure to read and follow the Code of Conduct.
If your proposal for contribution has been accepted, read the instructions below on how to work with and contribute to this project.