From 349e7c7eb1969b33b14798f71e0e57d8d34f935c Mon Sep 17 00:00:00 2001 From: paul Date: Mon, 14 Jul 2025 20:15:10 +0200 Subject: [PATCH] feat: add GitHub issue and PR templates - Add bug report template with environment details - Add feature request template with use case section - Add documentation improvement template - Add security vulnerability template with warnings - Add question template for support - Add issue template config with helpful links - Add comprehensive pull request template - Update mirror workflow to exclude production guide These templates will help maintain quality contributions and streamline the issue/PR process on GitHub. --- .gitea/workflows/mirror-to-github.yml | 3 +- .github/ISSUE_TEMPLATE/bug_report.md | 47 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++ .github/ISSUE_TEMPLATE/documentation.md | 33 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 38 ++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 26 ++++++++++ .../ISSUE_TEMPLATE/security_vulnerability.md | 37 ++++++++++++++ .github/pull_request_template.md | 49 +++++++++++++++++++ 8 files changed, 243 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/security_vulnerability.md create mode 100644 .github/pull_request_template.md diff --git a/.gitea/workflows/mirror-to-github.yml b/.gitea/workflows/mirror-to-github.yml index d91f62c..16702d7 100644 --- a/.gitea/workflows/mirror-to-github.yml +++ b/.gitea/workflows/mirror-to-github.yml @@ -36,10 +36,11 @@ jobs: git rm -r --cached .gitea/ || true git rm -r --cached scripts/install-gitea-runner.sh || true git rm -r --cached .drone* || true - git rm -r --cached .github-mirrow-exclude || true + git rm -r --cached .github-mirror-exclude || true git rm -r --cached .gitattributes-github || true git rm -r --cached photo-sharing-prd.md || true git rm -r --cached CLAUDE.md || true + git rm -r --cached PRODUCTION_DEPLOYMENT_GUIDE.md || true # Commit the changes diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..6e0f33f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,47 @@ +--- +name: Bug report +about: Create a report to help us improve PicPeak +title: '[BUG] ' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + - OS: [e.g. Ubuntu 22.04] + - Browser: [e.g. Chrome 120, Safari 17] + - PicPeak Version: [e.g. 1.0.22] + - Deployment Method: [e.g. Docker Compose, Manual] + - Database: [e.g. PostgreSQL 15, SQLite] + +**Logs** +Please include relevant logs: +``` +# Backend logs +docker-compose logs backend | tail -50 + +# Frontend console errors +[paste any browser console errors] +``` + +**Additional context** +Add any other context about the problem here. + +**Possible Solution** +If you have an idea how to fix the issue, please describe it here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ed0a0f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: 📚 Documentation + url: https://github.com/the-luap/picpeak/blob/main/DEPLOYMENT.md + about: Please read the documentation before opening an issue + - name: 💬 Discussions + url: https://github.com/the-luap/picpeak/discussions + about: Ask questions and discuss with the community + - name: 🔒 Security Issues + url: https://github.com/the-luap/picpeak/blob/main/SECURITY.md + about: Please review our security policy for reporting vulnerabilities \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..5f39614 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,33 @@ +--- +name: Documentation +about: Report issues or improvements needed in documentation +title: '[DOCS] ' +labels: 'documentation' +assignees: '' + +--- + +**What documentation needs improvement?** +Please specify which document or section needs attention: +- [ ] README.md +- [ ] DEPLOYMENT.md +- [ ] CONTRIBUTING.md +- [ ] API Documentation +- [ ] Code Comments +- [ ] Other: ___________ + +**Describe the issue** +What's wrong or missing in the documentation? + +**Suggested improvement** +How would you improve this documentation? + +**Target audience** +Who is this documentation for? +- [ ] New users setting up PicPeak +- [ ] Developers contributing to the project +- [ ] System administrators +- [ ] End users (photographers/clients) + +**Additional context** +Add any other context, examples, or references here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..8afa105 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,38 @@ +--- +name: Feature request +about: Suggest an idea for PicPeak +title: '[FEATURE] ' +labels: 'enhancement' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Use Case** +Please describe how this feature would be used: +- Who would use it? (photographers, clients, admins) +- When would they use it? +- Why is it important? + +**Similar Features** +Are there similar features in: +- PicDrop +- Scrapbook.de +- Other photo sharing platforms + +**Mockups or Examples** +If applicable, add mockups, diagrams, or links to similar implementations. + +**Additional context** +Add any other context or screenshots about the feature request here. + +**Implementation Ideas** +If you have technical ideas about how this could be implemented, please share them. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..9d20dc5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,26 @@ +--- +name: Question +about: Ask a question about PicPeak +title: '[QUESTION] ' +labels: 'question' +assignees: '' + +--- + +**Question** +What would you like to know about PicPeak? + +**Context** +Please provide context to help us answer your question better: +- What are you trying to achieve? +- What have you already tried? +- Which documentation have you consulted? + +**Environment** +If relevant to your question: +- PicPeak Version: +- Deployment Method: +- Operating System: + +**Related Issues or Discussions** +Link to any related issues, discussions, or documentation. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/security_vulnerability.md b/.github/ISSUE_TEMPLATE/security_vulnerability.md new file mode 100644 index 0000000..6846408 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security_vulnerability.md @@ -0,0 +1,37 @@ +--- +name: Security Vulnerability +about: Report security issues privately +title: '[SECURITY] ' +labels: 'security' +assignees: '' + +--- + +⚠️ **IMPORTANT: For serious security vulnerabilities, please DO NOT create a public issue.** + +Instead, please email security@example.com with the details. + +For minor security improvements or questions, you can use this template: + +**Type of Security Issue** +- [ ] Authentication/Authorization +- [ ] Data Exposure +- [ ] Input Validation +- [ ] Configuration Issue +- [ ] Dependency Vulnerability +- [ ] Other: ___________ + +**Description** +Brief description of the security concern. + +**Impact** +What could an attacker potentially do? + +**Steps to Reproduce** +If applicable, how can this be reproduced? + +**Suggested Fix** +If you have ideas on how to fix this issue. + +**References** +Any relevant security advisories, CVEs, or documentation. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..ae794d4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,49 @@ +## Description + +Please include a summary of the changes and which issue is fixed. Include relevant motivation and context. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] 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 + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. + +- [ ] Unit tests pass (`npm test`) +- [ ] Manual testing completed +- [ ] Tested on Docker deployment +- [ ] Tested on production-like environment + +**Test Configuration**: +* PicPeak Version: +* Node.js Version: +* Database: PostgreSQL / SQLite +* Browser: + +## Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] 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 updated the CHANGELOG.md file + +## Screenshots (if appropriate): + +## Additional Notes: + +Add any additional notes, concerns, or discussion points here. \ No newline at end of file