Skip to content

docs: Create developer documentation file - #31

Open
SturmEnte wants to merge 19 commits into
mainfrom
docs/developer-documentation
Open

SturmEnte wants to merge 19 commits into
mainfrom
docs/developer-documentation

Conversation

@SturmEnte

Copy link
Copy Markdown
Collaborator

No description provided.

@SturmEnte SturmEnte linked an issue Oct 5, 2026 that may be closed by this pull request
@SturmEnte
SturmEnte marked this pull request as ready for review October 8, 2026 11:31

@soerendomroes soerendomroes left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Könntest du bitte die benutzten Versionen (Rust) dokumentieren?

Außerdem vermisse ich eine Anleitung um das ganze auch zu releasen. Wie könnte ich einen cargo release machen?

@SturmEnte

Copy link
Copy Markdown
Collaborator Author

Ich habe die Dokumentation noch um die Rust Version und Edition ergänzt.

Wie man eine neue Version veröffentlicht ist bereits enthalten:

player_rust/CONTRIBUTING.md

Lines 124 to 145 in 0cfd52e

## Veröffentlichen
Eine neue Version wird über den Workflow "Release" in den GitHub Actions veröffentlicht.
### Schritte
1. Die neue Version muss im Release-Workflow angegeben werden.
2. Der Workflow aktualisiert automatisch die Cargo-Dateien.
3. Verschiedene Tests werden ausgeführt, um sicherzustellen, dass die neue Version korrekt funktioniert.
4. In ``CHANGELOG.md`` muss ein Eintrag für die neue Version vorhanden sein, der die Änderungen der Version beschreibt. Fehlt dieser Eintrag, kann die Veröffentlichung nicht erfolgen.
5. Wenn alle Voraussetzungen erfüllt sind, pusht der Workflow die aktualisierten Cargo-Dateien in den ``main``-Branch und veröffentlicht die neue Version auf Crates.io und GitHub.
### Versionierung
Das Versionsformat lautet:
saison.breaking-changes.fixes-features-and-co
Beispiel für `27.1.2`:
- `27`: Saison 2026/27
- `1`: Es wurde eine Änderung an der Schüler-API vorgenommen
- `2`: Nach dieser Änderung wurden zwei Versionen mit normalen Änderungen veröffentlicht

@SturmEnte

SturmEnte commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator Author

Achso und aktuell muss man noch die Branch Protection temporär deaktivieren, um eine neue Version zu veröffentlichen.
Ich hab mir das aufgeschrieben, irgendwann in den nächsten Tagen werde ich das Problem wahrscheinlich gelöst bekommen.
#35

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for developers and pupils

3 participants