jaandGitHub
af4bee0e4d
* feat: Add issue reporting guidelines to README.md
- Add dedicated "🐛 Issue Reporting" section with clear instructions
- Direct users to main repository issue tracker
- Include template for issue reporting with required information
- Improve project transparency and user support workflow
* fix: Update repository references and add issue reporting guidelines
- Fix incorrect repository reference (satwareAG-ironMike → satwareAG)
- Add comprehensive issue reporting section
- Clarify workflow between forks and main repository
- Improve contribution process documentation
* feat: Add GitHub issue templates for better issue management
- Add bug report template with structured fields
- Provide clear guidance for issue reporting
- Improve issue quality and processing efficiency
* feat: Add feature request template
- Add structured feature request template
- Include sections for use case, implementation details, and alternatives
- Improve feature planning and discussion process
* feat: Add content issue template
- Add template for content-related issues (typos, outdated info, etc.)
- Provide specific fields for content corrections
- Improve content quality maintenance process
* feat: Add issue template configuration
- Configure issue template chooser with clear options
- Add contact links for support and security
- Improve issue routing and user guidance
* feat: Add pull request template
- Add comprehensive PR template with structured sections
- Include checklist for quality assurance
- Improve code review and integration process
93 lines
2.3 KiB
Markdown
93 lines
2.3 KiB
Markdown
# Pull Request
|
|
|
|
## 📝 Description
|
|
|
|
<!-- Provide a brief description of the changes in this PR -->
|
|
|
|
**What does this PR do?**
|
|
|
|
- [ ] Add new content
|
|
- [ ] Update existing content
|
|
- [ ] Fix bugs
|
|
- [ ] Improve styling/design
|
|
- [ ] Update documentation
|
|
- [ ] Other: _____
|
|
|
|
**Summary of changes:**
|
|
<!-- Describe what you've changed/added/fixed -->
|
|
|
|
## 🔗 Related Issues
|
|
|
|
<!-- Link any related issues. Use "Fixes #123" to automatically close issues when PR is merged -->
|
|
- Relates to #
|
|
- Fixes #
|
|
- Closes #
|
|
|
|
## 🧪 Testing
|
|
|
|
**How has this been tested?**
|
|
|
|
- [ ] Tested locally with `./mkdocs.sh`
|
|
- [ ] Tested in multiple browsers
|
|
- [ ] Tested on mobile/tablet
|
|
- [ ] Links verified
|
|
- [ ] All pages load correctly
|
|
- [ ] No broken functionality
|
|
|
|
**Test environment:**
|
|
- OS:
|
|
- Browser(s):
|
|
- Device type:
|
|
|
|
## 📸 Screenshots
|
|
|
|
<!-- If applicable, add screenshots to help explain your changes -->
|
|
|
|
**Before:**
|
|
<!-- Screenshot of the current state (if applicable) -->
|
|
|
|
**After:**
|
|
<!-- Screenshot of your changes -->
|
|
|
|
## ✅ Checklist
|
|
|
|
**Before submitting this PR:**
|
|
|
|
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
|
|
- [ ] My code follows the project's style guidelines
|
|
- [ ] I have performed a self-review of my changes
|
|
- [ ] I have tested my changes locally
|
|
- [ ] I have checked that all links work correctly
|
|
- [ ] My changes generate no new warnings or errors
|
|
- [ ] I have added/updated documentation if needed
|
|
- [ ] My commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
|
|
|
|
**Content changes (if applicable):**
|
|
|
|
- [ ] Content is accurate and up-to-date
|
|
- [ ] Spelling and grammar are correct
|
|
- [ ] Links are working and relevant
|
|
- [ ] Images have appropriate alt text
|
|
- [ ] Content follows the site's tone and style
|
|
|
|
**Technical changes (if applicable):**
|
|
|
|
- [ ] Code is properly formatted
|
|
- [ ] No hardcoded values where configuration should be used
|
|
- [ ] Changes are backward compatible
|
|
- [ ] Performance impact has been considered
|
|
|
|
## 💬 Additional Notes
|
|
|
|
<!-- Add any additional context, concerns, or notes for reviewers -->
|
|
|
|
## 📋 Reviewer Checklist
|
|
|
|
<!-- For maintainers reviewing this PR -->
|
|
|
|
- [ ] Changes are properly tested
|
|
- [ ] Documentation is updated if needed
|
|
- [ ] No breaking changes introduced
|
|
- [ ] Security implications considered
|
|
- [ ] Performance impact acceptable
|
|
- [ ] Follows project conventions |