gitea-admin/gh-christianlouis-quizzicalbeats
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add security fixes and comprehensive documentation

Browse Source 
Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-02-06 21:59:19 +00:00
parent 47154c28d2
commit 9ea40bec61
12 changed files with 2254 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/bug_report.yml
+139
View File
@@ -0,0 +1,139 @@
name: Bug Report
description: Report a bug or unexpected behavior
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the form below to help us investigate.
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: What happened?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: I expected...
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
placeholder: Instead...
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of Quizzical Beats are you running?
options:
- Latest (main branch)
- v1.9 (Security Hardening)
- v1.8 (Documentation Dynamo)
- v1.7 (Dropbox Dispatch)
- v1.6 (Bulletproof Backups)
- Other (please specify in additional context)
validations:
required: true
- type: dropdown
id: deployment
attributes:
label: Deployment Method
description: How are you running Quizzical Beats?
options:
- Docker Compose (recommended)
- Docker (custom)
- Manual installation (pip)
- Other (please specify)
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment Details
description: |
Provide relevant environment information:
- OS (e.g., Ubuntu 22.04, macOS 13, Windows 11)
- Python version (e.g., 3.11)
- Browser (if web UI issue)
- Database (SQLite, PostgreSQL, MySQL)
placeholder: |
- OS: Ubuntu 22.04
- Python: 3.11.5
- Browser: Chrome 120
- Database: SQLite
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant Logs
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code.
**Security Note**: Remove any API keys, tokens, or personal information!
render: shell
placeholder: |
Paste logs here...
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
placeholder: Drag and drop images here or paste URLs
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other context about the problem here.
placeholder: Any additional information that might be helpful...
validations:
required: false
- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
description: Please confirm the following before submitting
options:
- label: I have searched existing issues to ensure this is not a duplicate
required: true
- label: I have removed any sensitive information (API keys, passwords, etc.) from logs and screenshots
required: true
- label: I am using a supported version of Quizzical Beats
required: true
.github/ISSUE_TEMPLATE/feature_request.yml
+114
View File
@@ -0,0 +1,114 @@
name: Feature Request
description: Suggest a new feature or enhancement
title: "[Feature]: "
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! Please provide as much detail as possible.
- type: textarea
id: problem
attributes:
label: Problem Statement
description: Is your feature request related to a problem? Please describe.
placeholder: I'm always frustrated when...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like to see
placeholder: I would like...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Describe any alternative solutions or features you've considered
placeholder: I also thought about...
validations:
required: false
- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Critical (blocking my use)
- High (would significantly improve experience)
- Medium (nice to have)
- Low (minor enhancement)
validations:
required: true
- type: dropdown
id: category
attributes:
label: Feature Category
description: Which area does this feature relate to?
options:
- Import/Export
- Round Generation
- User Interface
- Authentication
- API Integration
- Performance
- Security
- Documentation
- Other
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe how you would use this feature
placeholder: I would use this feature to...
validations:
required: false
- type: textarea
id: mockups
attributes:
label: Mockups or Examples
description: If applicable, add mockups, wireframes, or links to similar features in other apps
placeholder: Drag and drop images here or paste URLs
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any other context about the feature request here
placeholder: Any additional information...
validations:
required: false
- type: checkboxes
id: contribution
attributes:
label: Contribution
description: Would you be willing to contribute to this feature?
options:
- label: I would like to implement this feature myself
- label: I can help test this feature
- label: I can help write documentation for this feature
- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
options:
- label: I have searched existing issues and feature requests
required: true
- label: I have checked the roadmap to see if this is already planned
required: true
.github/ISSUE_TEMPLATE/security.yml
+59
View File
@@ -0,0 +1,59 @@
name: Security Vulnerability
description: Report a security vulnerability (private disclosure)
title: "[Security]: "
labels: ["security"]
body:
- type: markdown
attributes:
value: |
## ⚠️ SECURITY NOTICE
**DO NOT** report security vulnerabilities in public issues!
Please report security issues privately via email to:
**christian@kaufdeinquiz.com**
See [SECURITY.md](https://github.com/christianlouis/QuizzicalBeats/blob/main/SECURITY.md) for our full security policy.
---
This issue template is for non-critical security improvements or discussions only.
- type: textarea
id: description
attributes:
label: Security Concern Description
description: Describe the security improvement or concern (not a vulnerability)
placeholder: I noticed that...
validations:
required: true
- type: dropdown
id: severity
attributes:
label: Severity
description: How severe is this concern?
options:
- Low (security improvement suggestion)
- Medium (potential security issue)
- High (security vulnerability - REPORT VIA EMAIL!)
validations:
required: true
- type: textarea
id: impact
attributes:
label: Potential Impact
description: What could happen if this is not addressed?
placeholder: This could lead to...
validations:
required: false
- type: textarea
id: recommendation
attributes:
label: Recommendation
description: What steps should be taken to address this?
placeholder: I recommend...
validations:
required: false
.github/PULL_REQUEST_TEMPLATE.md
+135 -15
View File
@@ -1,32 +1,152 @@
# Pull Request Template
# Pull Request
## Description
Provide a brief description of the changes made in this pull request. Include the motivation and context for the change.
Fixes # (issue)
<!-- Provide a brief description of your changes -->
## Type of Change
<!-- Mark the relevant option with an 'x' -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring
- [ ] Security fix
- [ ] Dependency update
## Checklist
## Related Issues
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
<!-- Link to related issues using #issue_number -->
Fixes #
Relates to #
## Changes Made
<!-- List the specific changes you made -->
-
-
-
## Testing
<!-- Describe the testing you performed -->
### Test Environment
- OS:
- Python Version:
- Database:
- Browser (if applicable):
### Tests Performed
- [ ] Unit tests pass
- [ ] Integration tests pass
- [ ] Manual testing completed
- [ ] Browser compatibility tested (if UI changes)
### Test Coverage
<!-- If you added new code, describe the test coverage -->
- [ ] Added new tests for new functionality
- [ ] Updated existing tests
- [ ] No tests needed (documentation/config only)
## Security Checklist
<!-- Confirm security considerations -->
- [ ] No sensitive data (API keys, passwords, tokens) included in code
- [ ] All user inputs are validated and sanitized
- [ ] No SQL injection vulnerabilities
- [ ] No XSS vulnerabilities
- [ ] Dependencies checked for known vulnerabilities
- [ ] Security implications documented (if applicable)
## Documentation
<!-- Documentation updates -->
- [ ] Code comments added/updated
- [ ] README.md updated (if needed)
- [ ] Documentation updated (if needed)
- [ ] CHANGELOG.md updated
- [ ] API documentation updated (if applicable)
## Screenshots (if applicable)
Add screenshots to help explain your changes if applicable.
<!-- If applicable, add screenshots to demonstrate UI changes -->
## Additional Context
### Before
Add any other context or information about the pull request here.
### After
## Deployment Notes
<!-- Any special deployment considerations -->
- [ ] Database migrations required
- [ ] Environment variables added/changed
- [ ] Configuration changes needed
- [ ] Dependencies updated (requirements.txt)
- [ ] No deployment steps required
### Migration Steps
<!-- If migrations are required, list the steps -->
1.
2.
## Performance Impact
<!-- Describe any performance implications -->
- [ ] No performance impact
- [ ] Performance improved
- [ ] Performance impact (explain below)
## Breaking Changes
<!-- If this is a breaking change, describe what breaks and migration path -->
## Checklist
<!-- Final checklist before submitting -->
- [ ] My code follows the project's coding standards (PEP 8)
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published
- [ ] I have checked my code for security vulnerabilities
## Additional Notes
<!-- Any additional information that reviewers should know -->
---
## For Reviewers
### Review Focus Areas
- [ ] Security implications
- [ ] Performance impact
- [ ] Code quality and maintainability
- [ ] Test coverage
- [ ] Documentation completeness