docs: Add LICENSE, CONTRIBUTING.md, CHANGELOG.md, and .gitignore
- Add MIT License for open source clarity - Add .gitignore to prevent unwanted files in commits - Add CONTRIBUTING.md guidelines for contributors - Add CHANGELOG.md template for version tracking Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
46
CONTRIBUTING.md
Normal file
46
CONTRIBUTING.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Contribution Guidelines
|
||||
|
||||
Vielen Dank dafür, dass Sie zu diesem Projekt beitragen möchten!
|
||||
|
||||
## Wie kann ich beitragen?
|
||||
|
||||
### Bugs berichten
|
||||
- Erstellen Sie ein Issue mit dem Label "bug"
|
||||
- Beschreiben Sie das Problem so detailliert wie möglich
|
||||
- Geben Sie Schritte zur Reproduktion an
|
||||
- Teilen Sie Ihre Umgebung mit (OS, Software-Version, etc.)
|
||||
|
||||
### Features vorschlagen
|
||||
- Erstellen Sie ein Issue mit dem Label "enhancement"
|
||||
- Beschreiben Sie das Feature und seinen Nutzen
|
||||
- Geben Sie Beispiele für die Verwendung an
|
||||
|
||||
### Code beitragen
|
||||
1. **Fork** dieses Repository
|
||||
2. **Clone** Ihren Fork: `git clone <your-fork-url>`
|
||||
3. **Branch erstellen**: `git checkout -b feature/your-feature`
|
||||
4. **Änderungen committen**: `git commit -m 'Add some feature'`
|
||||
5. **Push**: `git push origin feature/your-feature`
|
||||
6. **Pull Request** erstellen
|
||||
|
||||
## Code-Stil
|
||||
|
||||
- Folgen Sie den bestehenden Code-Konventionen
|
||||
- Schreiben Sie aussagekräftige Commit-Messages
|
||||
- Dokumentieren Sie Ihre Änderungen
|
||||
|
||||
## Pull Request Prozess
|
||||
|
||||
1. Update die Dokumentation wenn nötig
|
||||
2. Sorgen Sie dafür, dass Tests bestehen (sofern vorhanden)
|
||||
3. Erstellen Sie einen PR mit klarer Beschreibung
|
||||
4. Warten Sie auf Review
|
||||
|
||||
## Lizenz
|
||||
|
||||
Durch das Einreichen von Beiträgen erklären Sie sich damit einverstanden, dass diese unter derselben Lizenz wie das Projekt lizenziert sind.
|
||||
|
||||
## Fragen?
|
||||
|
||||
Erstellen Sie ein Issue oder kontaktieren Sie die Maintainer.
|
||||
|
||||
Reference in New Issue
Block a user