Skip to content

Commit b738978

Browse files
committed
docs: add pull request template
1 parent 6bf88fa commit b738978

2 files changed

Lines changed: 72 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Pull Request
3+
about: Submit a code change for review
4+
5+
---
6+
# Pull Request
7+
8+
## Description
9+
10+
A clear and concise description of what this pull request changes.
11+
12+
## Motivation and Context
13+
14+
Why is this change required? What problem does it solve?
15+
16+
## How Has This Been Tested?
17+
18+
Please describe in detail how you tested your changes.
19+
20+
## Screenshots
21+
22+
If applicable, add screenshots to help explain your changes.
23+
24+
## Types of changes
25+
26+
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
27+
28+
- [ ] Bug fix (non-breaking change which fixes an issue)
29+
- [ ] New feature (non-breaking change which adds functionality)
30+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
31+
- [ ] Documentation update
32+
- [ ] Other (please describe):
33+
34+
## Checklist
35+
36+
Put an `x` in all the boxes that apply:
37+
38+
- [ ] I have added tests that prove my fix is effective or that my feature works
39+
- [ ] I have added necessary documentation
40+
- [ ] My changes generate no new warnings
41+
- [ ] I have updated the README.md file if necessary

.github/SECURITY.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability, please send an email to [security@example.com](mailto:security@example.com). Please do not create a GitHub issue for the vulnerability.
6+
7+
To help us triage the issue, please include the following information in your email:
8+
9+
- A brief description of the type of vulnerability
10+
- Steps to reproduce the vulnerability
11+
- Versions affected
12+
- Mitigation or workarounds, if any
13+
14+
Our security team will review your report and respond as soon as possible to coordinate remediation.
15+
16+
## Supported Versions
17+
18+
This project is currently supported with security updates for the following versions:
19+
20+
| Version | Supported |
21+
|:-------:|-------------------:|
22+
| 1.x.x | :white_check_mark: |
23+
| 0.x.x | :x: |
24+
25+
## Security Disclosures
26+
27+
All security disclosures will be promptly acknowledged and investigated by our security team. We will keep you informed throughout the process of our investigation and resolution.
28+
29+
## Security Policy Changes
30+
31+
We reserve the right to make changes to this security policy at any time. If we make changes, we will update the SECURITY.md file and provide a summary of the changes. We encourage users to periodically review this file to stay informed of any changes.

0 commit comments

Comments
 (0)