Skip to content

Commit fc4be6e

Browse files
TimInTechclaude
andauthored
Add GitHub issue templates and improve README documentation (#76)
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) Claude-Session: https://claude.ai/code/session_018UA7GQaUJWFiHrJfc6Qb45 Co-authored-by: Claude <noreply@anthropic.com>
1 parent 578abac commit fc4be6e

5 files changed

Lines changed: 175 additions & 0 deletions

File tree

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: 🐛 Bug Report
2+
description: Report a problem with a setup, update, or Bedrock script.
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to file a bug report! Please fill in the sections below so we can reproduce and fix the issue quickly.
10+
- type: input
11+
id: script
12+
attributes:
13+
label: Affected script
14+
description: Which script did you run?
15+
placeholder: e.g. setup_minecraft.sh, setup_minecraft_lxc.sh, setup_bedrock.sh, update.sh
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: what-happened
20+
attributes:
21+
label: What happened?
22+
description: A clear and concise description of the bug, including the full error output.
23+
placeholder: Paste the terminal output / error here.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: steps
28+
attributes:
29+
label: Steps to reproduce
30+
description: How can we reproduce the problem?
31+
placeholder: |
32+
1. Run `./setup_minecraft.sh`
33+
2. See error ...
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: environment
38+
attributes:
39+
label: Environment
40+
description: Where did you run this?
41+
options:
42+
- Proxmox VM
43+
- Proxmox LXC/CT
44+
- Other (specify below)
45+
validations:
46+
required: true
47+
- type: input
48+
id: versions
49+
attributes:
50+
label: Versions
51+
description: Proxmox VE, guest OS, and Java version.
52+
placeholder: e.g. Proxmox VE 8.2, Debian 12, OpenJDK 21
53+
validations:
54+
required: false
55+
- type: checkboxes
56+
id: checks
57+
attributes:
58+
label: Before submitting
59+
options:
60+
- label: I re-downloaded the latest script from `main`.
61+
required: true
62+
- label: I searched existing issues and this is not a duplicate.
63+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation & Troubleshooting
4+
url: https://github.com/TimInTech/minecraft-server-Proxmox#troubleshooting
5+
about: Check the README troubleshooting section before opening an issue.
6+
- name: 💬 Questions & Discussion
7+
url: https://github.com/TimInTech/minecraft-server-Proxmox/issues
8+
about: For general questions, please open a regular issue.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: 💡 Feature Request
2+
description: Suggest an improvement or a new capability.
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Problem / motivation
10+
description: What are you trying to do, and what is missing or hard today?
11+
placeholder: I'm always frustrated when ...
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: proposal
16+
attributes:
17+
label: Proposed solution
18+
description: Describe what you'd like to happen.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: alternatives
23+
attributes:
24+
label: Alternatives considered
25+
description: Any workarounds or other approaches you thought about.
26+
validations:
27+
required: false
28+
- type: checkboxes
29+
id: checks
30+
attributes:
31+
label: Before submitting
32+
options:
33+
- label: I searched existing issues and this is not a duplicate.
34+
required: true

README.de.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,35 @@
1515

1616
---
1717

18+
## ✨ Warum dieses Repo?
19+
20+
- 🚀 **Installation mit einem Befehl** — ein einziges Skript richtet in Minuten einen produktionsreifen Minecraft-Server (Java **oder** Bedrock) auf Proxmox ein.
21+
- 🧩 **VM *und* LXC/CT** — unterstützt beide Proxmox-Virtualisierungsmodelle, inkl. fertigem CT-Helfer für Bedrock.
22+
- 🔄 **Selbst-aktualisierend**`update.sh` zieht den neuesten **stabilen** PaperMC-Build über die neue **Fill-v3-API** mit SHA256- + Größenprüfung.
23+
- 🔒 **Sicher voreingestellt** — verifizierte Downloads, zufällige CT-Passwörter, UFW-Firewall-Anleitung und Integritätsprüfungen (keine HTML-Fehlerseiten als `server.jar`).
24+
- 🧠 **Automatisch dimensionierter JVM-Speicher** — skaliert zum Host (`Xms ≈ RAM/4`, `Xmx ≈ RAM/2`, gedeckelt bei 16 G) — kein manuelles Tuning nötig.
25+
- 🛡️ **CI-geprüft** — jedes Shell-Skript wird bei jedem Push mit ShellCheck geprüft.
26+
- 🇩🇪🇬🇧 **Zweisprachige Doku** — vollständige deutsche und englische Dokumentation, synchron gehalten.
27+
28+
---
29+
30+
## 📑 Inhaltsverzeichnis
31+
32+
- [Voraussetzungen](#-voraussetzungen)
33+
- [Einführung](#einführung)
34+
- [Schnellstart](#schnellstart)
35+
- [Backups](#-backups)
36+
- [Auto-Update](#-auto-update)
37+
- [Konfiguration](#konfiguration)
38+
- [Integrität & Firewall](#integrität--firewall)
39+
- [Proxmox-CT-Helfer (Bedrock)](#proxmox-ct-helfer-bedrock)
40+
- [PaperMC-API-Migration (v2 → Fill v3)](#papermc-api-migration-v2--fill-v3)
41+
- [Admin/Befehle](#-adminbefehle)
42+
- [Fehlerbehebung](#fehlerbehebung)
43+
- [Referenzen](#referenzen)
44+
45+
---
46+
1847
## Quick Links
1948

2049
- Server-Befehle: [SERVER_COMMANDS.md](SERVER_COMMANDS.md)
@@ -296,6 +325,12 @@ Details zum sicheren Simulations-Workflow findest du in **[SIMULATION.md](SIMULA
296325
- Proxmox-Wiki: <https://pve.proxmox.com/wiki/Main_Page>
297326
- Mojang Bedrock Server: <https://www.minecraft.net/en-us/download/server/bedrock>
298327

328+
## ⭐ Star-Verlauf
329+
330+
Wenn dir dieses Projekt Zeit gespart hat: Ein ⭐ hilft anderen, es zu finden, und motiviert zur weiteren Pflege.
331+
332+
[![Star History Chart](https://api.star-history.com/svg?repos=TimInTech/minecraft-server-Proxmox&type=Date)](https://star-history.com/#TimInTech/minecraft-server-Proxmox&Date)
333+
299334
## Lizenz
300335

301336
[MIT](LICENSE)

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,35 @@
1515

1616
---
1717

18+
## ✨ Why this repo?
19+
20+
- 🚀 **One-command install** — a single script provisions a production-ready Minecraft server (Java **or** Bedrock) on Proxmox in minutes.
21+
- 🧩 **VM *and* LXC/CT** — supports both Proxmox virtualization models, plus a ready-made CT helper for Bedrock.
22+
- 🔄 **Self-updating**`update.sh` pulls the latest **stable** PaperMC build via the new **Fill v3 API** with SHA256 + size validation.
23+
- 🔒 **Secure by default** — verified downloads, random CT passwords, UFW firewall guidance, and integrity checks (no HTML error pages saved as `server.jar`).
24+
- 🧠 **Auto-sized JVM** — memory is scaled to the host (`Xms ≈ RAM/4`, `Xmx ≈ RAM/2`, capped at 16 G) — no manual tuning required.
25+
- 🛡️ **CI-linted** — every shell script is checked with ShellCheck on each push.
26+
- 🇩🇪🇬🇧 **Bilingual docs** — full English and German documentation, kept in sync.
27+
28+
---
29+
30+
## 📑 Table of Contents
31+
32+
- [Requirements](#-requirements)
33+
- [Introduction](#introduction)
34+
- [Quickstart](#quickstart)[VM](#vm-dhcp) · [LXC/CT](#lxcct) · [Bedrock](#bedrock)
35+
- [Backups](#-backups)
36+
- [Auto-Update](#-auto-update)
37+
- [Configuration](#configuration)
38+
- [Integrity & Firewall](#integrity--firewall)
39+
- [Proxmox CT Helper (Bedrock)](#proxmox-ct-helper-bedrock)
40+
- [PaperMC API Migration (v2 → Fill v3)](#papermc-api-migration-v2--fill-v3)
41+
- [Admin/Commands](#-admincommands)
42+
- [Troubleshooting](#troubleshooting)
43+
- [References](#references)
44+
45+
---
46+
1847
## Quick Links
1948

2049
- Server Commands: [SERVER_COMMANDS.md](SERVER_COMMANDS.md)
@@ -297,6 +326,12 @@ For safe simulation workflow details, see **[SIMULATION.md](SIMULATION.md)**.
297326
- Proxmox Wiki: <https://pve.proxmox.com/wiki/Main_Page>
298327
- Mojang Bedrock Server: <https://www.minecraft.net/en-us/download/server/bedrock>
299328

329+
## ⭐ Star History
330+
331+
If this project saved you time, a ⭐ helps others discover it and motivates continued maintenance.
332+
333+
[![Star History Chart](https://api.star-history.com/svg?repos=TimInTech/minecraft-server-Proxmox&type=Date)](https://star-history.com/#TimInTech/minecraft-server-Proxmox&Date)
334+
300335
## License
301336

302337
[MIT](LICENSE)

0 commit comments

Comments
 (0)