feat: Add comprehensive issue reporting and contribution guidelines (#105)

* 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
This commit is contained in:
ja
2025-06-02 17:59:20 +02:00
committed by GitHub
parent faf199aca7
commit af4bee0e4d
7 changed files with 498 additions and 35 deletions
+91
View File
@@ -0,0 +1,91 @@
name: 📝 Content Issue
description: Report issues with website content (typos, outdated information, etc.)
title: "[Content]: "
labels: ["content", "needs-review"]
body:
- type: markdown
attributes:
value: |
Thank you for helping improve our content! Every correction makes satware.ai better.
Before submitting, please search existing issues to avoid duplicates.
- type: input
id: page-url
attributes:
label: Page URL
description: Which page has the content issue?
placeholder: https://satware.ai/path/to/page
validations:
required: true
- type: dropdown
id: issue-type
attributes:
label: Content Issue Type
description: What type of content issue is this?
options:
- Typo/Grammar Error
- Outdated Information
- Broken Link
- Missing Information
- Incorrect Information
- Unclear/Confusing Content
- Translation Error
- Formatting Issue
- Other
validations:
required: true
- type: textarea
id: current-content
attributes:
label: Current Content
description: Copy and paste the problematic content (if applicable)
placeholder: Paste the current content that needs correction...
- type: textarea
id: suggested-correction
attributes:
label: Suggested Correction
description: How should the content be corrected?
placeholder: Provide your suggested correction...
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any additional context about the content issue
placeholder: |
- Why is this content incorrect/unclear?
- Do you have authoritative sources for the correction?
- Any other relevant details...
- type: input
id: section-location
attributes:
label: Section/Location
description: Where on the page is this content located?
placeholder: e.g., "Introduction section", "Step 3 of the tutorial", "Footer links"
- type: dropdown
id: severity
attributes:
label: Severity
description: How significant is this content issue?
options:
- Low - Minor typo or formatting
- Medium - Affects understanding
- High - Misleading or significantly outdated
- Critical - Factually incorrect or potentially harmful
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true