Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 4.41 KB

SECURITY.md

File metadata and controls

91 lines (64 loc) · 4.41 KB
Raw

Git Security Policy

Issue Title:

Please use an appropriate tag in the title to clearly indicate whether you are reporting a feature or a bug. Use [FEATURE] for new feature requests, [BUG] for bug reports and [VULNERABILITY] in the issue title to clearly indicate that you are reporting a security vulnerability. This will help us categorize and prioritize the issues appropriately.

Description:

Provide a detailed description of the feature or bug you are reporting. Be as specific as possible and include any relevant information that might help us understand the issue or desired functionality. Explain the problem or expected behavior clearly and concisely.

Environment:

Please include the environment details in your report, such as the operating system, browser, version, or any other relevant software or hardware configuration. This information will assist us in reproducing and troubleshooting the reported issue.

###Vulnerability Classification: If you have knowledge about the type or classification of the vulnerability (e.g., XSS, SQL injection, privilege escalation), please provide that information. It will help us better understand the nature of the issue and its potential impact.

Steps to Reproduce (for bugs):

In the case of a bug report, it is crucial to provide a clear set of steps to reproduce the issue. This will help our developers to isolate and fix the problem effectively. If applicable, include a code snippet or a minimal code sample that demonstrates the bug.

Expected Results:

Describe the expected outcome or desired functionality when reporting a bug or suggesting a feature. This will help us better understand your requirements and evaluate the proposed changes accurately.

Additional Information (optional):

If you have any supplementary information, screenshots, error messages, or relevant context that you believe would be helpful, please include it in the report. This can assist us in resolving the issue more efficiently. Use this section to tell people about which versions of your project are.

For example see below templates.

[BUG] Issue Title

Description: Provide a detailed description of the bug, including any error messages or unexpected behavior you encountered.

Environment:

  • Operating System: [e.g., Windows 10]
  • Browser: [e.g., Google Chrome version 91.0.4472.124]
  • Python Version: [e.g., 3.9.7]
  • Java Version: [e.g., 11]
  • Spark Version: [e.g., 3.2.3]
  • Hadoop Version: [e.g., 3.2]

Steps to Reproduce:

  1. Provide step-by-step instructions to reproduce the bug.
  2. If applicable, include a code snippet or a minimal code sample to recreate the issue.

Expected Results: Describe what you expected to happen when the bug occurred.

Additional Information: Include any supplementary information, screenshots, or relevant context that might be helpful in resolving the issue.

[VULNERABILITY] Issue Title

Description: Provide a detailed description of the vulnerability, including the affected component, its impact, and potential risks associated with it.

Environment:

  • Operating System: [e.g., Windows 10]
  • Browser: [e.g., Google Chrome version 91.0.4472.124]
  • Python Version: [e.g., 3.9.7]
  • Java Version: [e.g., 11]
  • Spark Version: [e.g., 3.2.3]
  • Hadoop Version: [e.g., 3.2]

Vulnerability Classification: If known, provide the classification or type of vulnerability (e.g., XSS, SQL injection).

Reproduction Steps and Proof of Concept:

  1. Clearly outline the steps to reproduce the vulnerability.
  2. If applicable, provide a proof of concept (PoC) or code snippet demonstrating the vulnerability (with caution).

Impact Assessment: Describe the potential scope, severity, and consequences of the vulnerability.

Suggested Mitigation: If you have any suggestions for mitigating the vulnerability, please include them.

Confidentiality: If the vulnerability has significant security implications or exposes sensitive information, please let us know.

Additional Information: Include any supplementary information, screenshots, or relevant context that supports your vulnerability report.

[FEATURE] Issue Title

Description: Provide a detailed description of the desired feature, including the problem it solves or the value it adds to the project.

Expected Results: Describe what you expect the feature to do or the behavior you anticipate after its implementation.

Additional Information: Include any additional information, screenshots, or relevant context that supports your feature request.