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
+18 -1
View File
@@ -94,6 +94,23 @@ The `satware.ai` website is automatically deployed to GitHub Pages.
* **SCSS Changes Not Reflecting**: Ensure the `scss_watcher.py` is running correctly within your Docker container. Check the Docker logs for any errors during SCSS compilation. The `scss_watcher.py` monitors `overrides/assets/css/custom.scss` and compiles it to `docs/assets/css/custom.css`.
* **Docker Issues**: If you encounter issues with the `./mkdocs.sh` script, verify that Docker is running and that you have the necessary permissions.
## 🐛 Issue Reporting
Found a bug, have a feature request, or experiencing issues with the satware.ai website? Please report all issues to our main repository:
**🎯 [Report Issues Here](https://github.com/satwareAG/satware.ai/issues)**
When reporting issues, please include:
- **Clear description** of the problem or feature request
- **Steps to reproduce** (if applicable)
- **Expected behavior** vs actual behavior
- **Browser/device information** (e.g., Chrome 120, Safari on iOS 17)
- **Screenshots or error messages** (if relevant)
- **URL** where the issue occurs (if specific to a page)
This helps our team address your concerns quickly and effectively. We appreciate your feedback in making satware.ai better for everyone!
## 🤝 Contributing
Contributions are welcome! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
@@ -104,4 +121,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
## 📧 Contact
For any inquiries or support, please contact [info@satware.ai](mailto:info@satware.ai).
For any inquiries or support, please contact [info@satware.ai](mailto:info@satware.ai).