Skip to content

Commit 690af68

Browse files
author
farhadzand
committed
Add initial GitHub workflows, security policies, and examples
- Created CI/CD workflows for automated testing, security audits, and maintenance. - Added security policy documentation and vulnerability reporting templates. - Introduced a .gitleaksignore file to manage false positives in secret detection. - Removed outdated example files for better clarity and focus on current usage patterns.
1 parent 37c9012 commit 690af68

File tree

14 files changed

+2148
-886
lines changed

14 files changed

+2148
-886
lines changed

‎.github/ISSUE_TEMPLATE/security-vulnerability.yml‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
name: 🔒 Security Vulnerability Report
2+
description: Report a security vulnerability in the Laravel Prometheus package
3+
title: "[Security] "
4+
labels: ["security", "vulnerability", "triage"]
5+
assignees:
6+
- iamfarhad
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
## Security Vulnerability Report
13+
14+
Thank you for taking the time to report a security vulnerability. We take security seriously and appreciate your responsible disclosure.
15+
16+
**Please do not report security vulnerabilities through public GitHub issues.**
17+
18+
For serious security vulnerabilities, please email: farhad.pd@gmail.com
19+
20+
- type: checkboxes
21+
id: preliminary-checks
22+
attributes:
23+
label: Preliminary Checks
24+
description: Please verify the following before submitting
25+
options:
26+
- label: I have searched for existing security reports
27+
required: true
28+
- label: This is a security vulnerability, not a general bug
29+
required: true
30+
- label: I understand this should not be a public issue for serious vulnerabilities
31+
required: true
32+
33+
- type: dropdown
34+
id: severity
35+
attributes:
36+
label: Severity Level
37+
description: How severe is this vulnerability?
38+
options:
39+
- Low (Minor information disclosure)
40+
- Medium (Moderate impact on security)
41+
- High (Significant security impact)
42+
- Critical (Immediate security threat)
43+
validations:
44+
required: true
45+
46+
- type: dropdown
47+
id: category
48+
attributes:
49+
label: Vulnerability Category
50+
description: What type of vulnerability is this?
51+
options:
52+
- Injection (SQL, Command, etc.)
53+
- Cross-Site Scripting (XSS)
54+
- Authentication/Authorization
55+
- Information Disclosure
56+
- Dependency Vulnerability
57+
- Configuration Issue
58+
- Other
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: description
64+
attributes:
65+
label: Vulnerability Description
66+
description: Provide a clear description of the vulnerability
67+
placeholder: |
68+
Describe the vulnerability:
69+
- What is the issue?
70+
- How can it be exploited?
71+
- What is the potential impact?
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: reproduction
77+
attributes:
78+
label: Steps to Reproduce
79+
description: Provide step-by-step instructions to reproduce the vulnerability
80+
placeholder: |
81+
1. Install the package with...
82+
2. Configure...
83+
3. Execute...
84+
4. Observe...
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: environment
90+
attributes:
91+
label: Environment Information
92+
description: Provide details about your environment
93+
placeholder: |
94+
- Package Version:
95+
- PHP Version:
96+
- Laravel Version:
97+
- Operating System:
98+
- Additional Dependencies:
99+
validations:
100+
required: true
101+
102+
- type: textarea
103+
id: impact
104+
attributes:
105+
label: Security Impact
106+
description: Describe the potential security impact
107+
placeholder: |
108+
- What data could be compromised?
109+
- What systems could be affected?
110+
- What privileges could be escalated?
111+
112+
- type: textarea
113+
id: mitigation
114+
attributes:
115+
label: Suggested Mitigation
116+
description: If you have suggestions for fixing the vulnerability, please share them
117+
placeholder: |
118+
- Potential fixes
119+
- Workarounds
120+
- Best practices to prevent similar issues
121+
122+
- type: checkboxes
123+
id: disclosure
124+
attributes:
125+
label: Responsible Disclosure
126+
description: Please confirm your commitment to responsible disclosure
127+
options:
128+
- label: I will not publicly disclose this vulnerability until it has been addressed
129+
required: true
130+
- label: I will provide reasonable time for the maintainers to fix the issue
131+
required: true
132+
- label: I understand this report may be shared with relevant security teams
133+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Pull Request
2+
3+
## Description
4+
Brief description of what this PR does.
5+
6+
## Type of Change
7+
<!-- Please mark the relevant option with an "x" -->
8+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
9+
- [ ] ✨ New feature (non-breaking change which adds functionality)
10+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
11+
- [ ] 📚 Documentation update
12+
- [ ] 🎨 Code style/formatting changes
13+
- [ ] ♻️ Refactoring (no functional changes)
14+
- [ ] ⚡ Performance improvement
15+
- [ ] 🔒 Security fix
16+
- [ ] 🧪 Test improvements
17+
- [ ] 🔧 Build/CI changes
18+
19+
## Related Issues
20+
<!-- Link to any related issues -->
21+
Fixes #(issue number)
22+
Related to #(issue number)
23+
24+
## Changes Made
25+
<!-- Detailed description of changes -->
26+
- Change 1
27+
- Change 2
28+
- Change 3
29+
30+
## Testing
31+
<!-- How was this change tested? -->
32+
- [ ] Unit tests pass
33+
- [ ] Integration tests pass
34+
- [ ] Manual testing completed
35+
- [ ] New tests added for new functionality
36+
37+
### Test Coverage
38+
- [ ] All new code is covered by tests
39+
- [ ] No decrease in overall test coverage
40+
- [ ] Edge cases are tested
41+
42+
## Performance Impact
43+
<!-- Does this change affect performance? -->
44+
- [ ] No performance impact
45+
- [ ] Performance improvement
46+
- [ ] Performance regression (explain below)
47+
48+
**Performance Notes:**
49+
<!-- If applicable, describe performance changes -->
50+
51+
## Security Considerations
52+
<!-- Any security implications? -->
53+
- [ ] No security implications
54+
- [ ] Security improvement
55+
- [ ] Potential security impact (explain below)
56+
57+
**Security Notes:**
58+
<!-- If applicable, describe security changes -->
59+
60+
## Breaking Changes
61+
<!-- If this is a breaking change, describe what breaks and migration path -->
62+
- [ ] This PR introduces breaking changes
63+
64+
**Breaking Change Details:**
65+
<!-- Describe what breaks and how to migrate -->
66+
67+
## Documentation
68+
<!-- Documentation changes -->
69+
- [ ] Documentation updated
70+
- [ ] No documentation changes needed
71+
- [ ] Documentation update required (create issue)
72+
73+
## Checklist
74+
<!-- Please mark completed items with an "x" -->
75+
- [ ] My code follows the project's style guidelines
76+
- [ ] I have performed a self-review of my code
77+
- [ ] I have commented my code, particularly in hard-to-understand areas
78+
- [ ] I have made corresponding changes to the documentation
79+
- [ ] My changes generate no new warnings
80+
- [ ] I have added tests that prove my fix is effective or that my feature works
81+
- [ ] New and existing unit tests pass locally with my changes
82+
- [ ] Any dependent changes have been merged and published
83+
84+
## Screenshots/Examples
85+
<!-- If applicable, add screenshots or code examples -->
86+
87+
## Additional Notes
88+
<!-- Any additional information that reviewers should know -->
89+
90+
---
91+
92+
## For Reviewers
93+
<!-- This section is for reviewers -->
94+
95+
### Review Focus Areas
96+
- [ ] Code quality and style
97+
- [ ] Test coverage and quality
98+
- [ ] Performance implications
99+
- [ ] Security considerations
100+
- [ ] Documentation accuracy
101+
- [ ] Breaking change impact
102+
103+
### Security Review
104+
- [ ] No sensitive data exposed
105+
- [ ] Input validation appropriate
106+
- [ ] Authorization checks in place
107+
- [ ] Injection vulnerabilities checked

0 commit comments

Comments
 (0)