Add GitHub issue templates and improve README documentation - #76
Merged
Conversation
Improve README first-impression and navigation, and lower the barrier for community contributions to help the project attract more stars: - Add a '✨ Why this repo?' feature highlight section (EN + DE) - Add a Table of Contents to both READMEs - Add a Star History chart + call-to-action section (EN + DE) - Add GitHub issue templates (bug report, feature request, config) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018UA7GQaUJWFiHrJfc6Qb45
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request – Simulation Only
Summary
This PR adds structured GitHub issue templates and enhances both English and German README documentation:
New Files:
.github/ISSUE_TEMPLATE/bug_report.yml— Guided bug report form with fields for affected script, error description, reproduction steps, environment, and pre-submission checks..github/ISSUE_TEMPLATE/feature_request.yml— Feature request template capturing problem statement, proposed solution, and alternatives..github/ISSUE_TEMPLATE/config.yml— Issue template configuration disabling blank issues and providing contact links to documentation and discussions.Documentation Updates:
README.md— Added "Why this repo?" section highlighting key features (one-command install, VM/LXC support, self-updating, security, auto-sized JVM, CI-linted, bilingual docs), table of contents with section links, and star history chart.README.de.md— Parallel German translation of the new sections with identical structure and content.These changes improve issue triage by standardizing bug and feature submissions, reduce duplicate issues through better documentation discoverability, and make the project more approachable to new users.
Checklist
SIMULATION.mdupdate needed (no behavioral or risk changes to scripts).Testing (Simulation)
Expected side effects when deployed:
Rollback: Simply delete the
.github/ISSUE_TEMPLATE/directory and revert README changes to restore previous behavior.https://claude.ai/code/session_018UA7GQaUJWFiHrJfc6Qb45