Skip to content

Commit 2526d54

Browse files
libdriverlibdriver
committed
docs: add SECURITY.md && ISSUE_TEMPLATE && PULL_REQUEST_TEMPLATE.md
1 parent 5ee09bb commit 2526d54

8 files changed

+163
-0
lines changed

‎.github/ISSUE_TEMPLATE/1_bug_report.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 🐛 Bug report
2+
description: Create a report to help us improve
3+
labels: [bug report]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for your report.
9+
10+
Please fill in as much of the following form as you're able.
11+
- type: input
12+
attributes:
13+
label: Version
14+
description: Code version.
15+
- type: textarea
16+
attributes:
17+
label: Describe the bug
18+
description: A clear and concise description of what the bug is.
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: To Reproduce
24+
description: Steps to reproduce the behavior.
25+
- type: textarea
26+
attributes:
27+
label: Expected behavior
28+
description: A clear and concise description of what you expected to happen.
29+
- type: textarea
30+
attributes:
31+
label: Additional context
32+
description: Add any other context about the bug report here.

‎.github/ISSUE_TEMPLATE/2_feature_request.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea for this project
3+
labels: [feature request]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for suggesting an idea to make LibDriver better.
9+
10+
Please fill in as much of the following form as you're able.
11+
- type: textarea
12+
attributes:
13+
label: Is your feature request related to a problem? Please describe.
14+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
- type: textarea
16+
attributes:
17+
label: Describe the solution you'd like
18+
description: A clear and concise description of what you want to happen.
19+
- type: textarea
20+
attributes:
21+
label: Describe alternatives you've considered
22+
description: A clear and concise description of any alternative solutions or features you've considered.
23+
- type: textarea
24+
attributes:
25+
label: Additional context
26+
description: Add any other context about the feature request here.

‎.github/ISSUE_TEMPLATE/3_documentation_problem.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: 📄 Documentation problem
2+
description: Report a documentation problem
3+
labels: [documentation problem]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for reporting the documentation problem to make LibDriver better.
9+
10+
Please fill in as much of the following form as you're able.
11+
- type: input
12+
attributes:
13+
label: Document Links
14+
description: Please fill in the link of the online documentation or the path of the offline documentation.
15+
- type: textarea
16+
attributes:
17+
label: Description of the problem
18+
description: A clear and concise description of the documentation problem.
19+
- type: textarea
20+
attributes:
21+
label: Please give your suggestion
22+
description: Please tell us how you would like to improve this documentation.
23+
- type: textarea
24+
attributes:
25+
label: Additional context
26+
description: Add any other context about the documentation problem here.

‎.github/ISSUE_TEMPLATE/4_ask_question.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: ❓ Ask question
2+
description: Ask a usage or consultation question
3+
labels: [ask question]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for your question.
9+
10+
Please fill in as much of the following form as you're able.
11+
- type: textarea
12+
attributes:
13+
label: Please ask your question
14+
description: Enter your question as detailed as possible.
15+
- type: textarea
16+
attributes:
17+
label: Additional context
18+
description: Add any other context about the question here.

‎.github/ISSUE_TEMPLATE/5_general_issues.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 🏆 General issues
2+
description: Report any other non-support related issues
3+
labels: [general issues]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for your report.
9+
10+
Please fill in as much of the following form as you're able.
11+
- type: textarea
12+
attributes:
13+
label: Description of the issues
14+
description: Please describe the issues as much detail as possible.
15+
- type: textarea
16+
attributes:
17+
label: Additional context
18+
description: Add any other context about the issues here.

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/PULL_REQUEST_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Pull request type(fix, feat,docs,style,etc.)
2+
3+
4+
5+
## Pull request change
6+
7+
8+
9+
## Pull request describe

‎SECURITY.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Security Policy
2+
3+
LibDriver takes the security of our code seriously.If you believe you have found a security vulnerability in our code, please report it to us as described below.
4+
5+
## Reporting a Vulnerability
6+
7+
LibDriver is generally backwards compatible with very few exceptions, so we recommend users to always use the latest version to experience stability, performance and security.
8+
9+
**Please do not report security vulnerabilities through public issues.**
10+
11+
Instead, please send an email to [email protected]. You should receive a response within 24 hours. If for some reason you do not, please send again to ensure we received your original message. If your report was previously undisclosed, we’ll also mention your name in the credits.
12+
13+
Please include the requested information listed below to help us better understand the nature and scope of the possible issue:
14+
15+
- Type of issue
16+
- Full paths of source file(s) related to the manifestation of the issue
17+
- The location of the affected source code
18+
- Any special configuration required to reproduce the issue
19+
- Step-by-step instructions to reproduce the issue
20+
- Proof-of-concept or exploit code
21+
- Impact of the issue, including how an attacker might exploit the issue
22+
23+
After receiving your report, we will evaluate your report as soon as possible and notify you of the results. Bug fixes depend on the bug itself, and we will try to fix bugs as quickly as possible.
24+
25+
## Preferred Languages
26+
27+
We prefer all communications to be in English.
28+
29+
## Responsible Disclosure
30+
31+
In some cases, we may apply a responsible disclosure process to reported or otherwise discovered vulnerabilities. We will usually do that for a critical vulnerability, and only if we have a good reason to believe information about it is not yet public.
32+
33+
This process involves providing an early notification about the vulnerability, its impact and mitigations to a short list of vendors under a time-limited embargo on public disclosure.

0 commit comments

Comments
 (0)