Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 2.9 KB
Raw

Contributing

First off, thank you for taking the time to contribute!

Here are some important resources:

  • Security Policy: If you need to share a security vulnerability, please refer to our Security Policy.
  • Slack Discussions: Any questions - join us on Slack
  • Documentation: Start with the project README.
  • License: This project is 100% open source, using the Apache 2.0 license. Dependencies may use other open source licenses.
  • Contributor License: The Apache 2.0 license applies to all contributions offered to this project.
  • Code of Conduct: The project community strives to be open and welcoming to all.

How can I contribute?

I'm having difficulty installing, operating or building this project

Head over to our Community Slack and share what's going on. It's generally useful to include details of your installation, docker images list and docker ps -a, or the equivalent Kubernetes commands are a good start. Logs from any containers that may be misbehaving are also useful.

I think I have found a bug

If you believe you've found a security vulnerability, please refer to our Security Policy.

For all other bugs, please first check if the issue has already been opened. If so, go ahead and add details to the existing issue.

If the bug appears to be new, please open a new GitHub Bug report. The template will prompt you for the information that will help us to understand and address the issue.

I'd like to share a change

Thank you. Please send a GitHub Pull Request with a clear explanation of what you're seeking to achieve, and what you have done.

Code Style: we're flexible and accomodating. Copy the style of the code adjacent to your contributions, keep it clear and easy to understand for other developers and we're all good.

I have an idea for an enhancement

If it's a well-formed enhancement, please open a new GitHub Feature request. Explain the enhancement and any supporting information - who it benefits, why it's important etc.

If you'd like to discuss the idea before proposing it on GitHub, share it on our Community Slack and we will work through it together.

I'd like to talk to someone directly

You can reach out to Deepfence's community leads at community at deepfence dot io.