Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

41 lines (23 loc) · 2.76 KB
Raw

Contributing to FlowMeter

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
  • FlowMeter License: FlowMeter is 100% open source, using the Apache 2.0 license.
  • Contributor License: The Apache 2.0 license applies to all contributions offered to the FlowMeter project.
  • Code of Conduct: The FlowMeter community strives to be open and welcoming to all.

How can I contribute?

I'm having difficulty installing, operating or building FlowMeter

Head over to our Community Slack and share what's going on.

I think I have found a bug in FlowMeter

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 to FlowMeter

Thank you. Please send a GitHub Pull Request to FlowMeter 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 to FlowMeter

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 the ThreatMapper community leads at community at deepfence dot io.