Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 4.56 KB

SUPPORT.md

File metadata and controls

59 lines (35 loc) · 4.56 KB

CrowdStrike Falcon

Repository Support

foundry-fn-python is a community-driven, open source project designed to assist developers in leveraging the power of CrowdStrike APIs within their solutions. While not a formal CrowdStrike product, foundry-fn-python is maintained by CrowdStrike and supported in partnership with the open source developer community.

Issue Reporting and Questions 🐛

Issues may be reported here and are used to track bugs, documentation and link updates, enhancement requests and security concerns.

Issue Formatting (MCVE)

Whenever possible, please try to format issues and questions in the Minimal, Complete, and Verifiable Example format. This format reduces "noise", allowing the community to better understand your concern, and provide you with a solution more quickly. This also reduces the likelihood of confidential environment details being accidentally shared within your post.

MCVE formatted code examples provided within issues or questions should be:

  • Minimal: Provide as little as code as possible to produce the problem.
  • Complete: Provide all the necessary programmatic pieces to recreate the issue.
    • Do not provide screenshots of code.
    • Use code blocks for each file or snippet. Include a description with each block.
    • Provide all error messages received, including the complete traceback.
  • Reproducible: Provide code that reliably reproduces the problem.
    • Provide as much detail regarding the problem as possible.
    • Test your example to make sure it produces consistent results.

To read more about MCVE format, review this post on Stack Overflow. For tips on how to properly format questions, check out the blog post by @mrocklin on crafting minimal bug reports.

Report Issue

Support Escalation

Generally, we endeavor to provide support for using foundry-fn-python here within the repository. This expands our online knowledge base, enables self-help for our community, and can reduce the amount of time for you to receive answers.

If you are a CrowdStrike customer and you would prefer to have your questions or issues handled directly with CrowdStrike Support, you are welcome to contact the CrowdStrike technical support team.

API or Out of Scope Issues

Depending on the root cause, there is a possibility that an identified issue exceeds the scope of the foundry-fn-python SDK, and may require additional investigation. A maintainer may ask you to contact the CrowdStrike technical support team directly should this occur.

Confidentiality

There are also situations where aspects of a support concern cannot be discussed in an online forum, such as:

  • customer entitlement
  • data sensitivity
  • environment configuration

MCVE format is designed to reduce the potential for encountering confidentiality concerns while describing your issue, but cannot speak to every scenario. If one of these concerns impacts your ability to post an issue to this repository, please contact the CrowdStrike technical support team directly making sure to highlight the concern as part of your support request.



WE STOP BREACHES