Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Boomtrexx committed Dec 5, 2023
1 parent a6df197 commit 69f07f9
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Mitarbeit an say-hello-functions

Willkommen bei say-hello-functions! Wir freuen uns, dass du daran interessiert bist, einen Beitrag zu leisten.

## Inhaltsverzeichnis
1. [Verhaltenskodex](#verhaltenskodex)
2. [Wie kann ich beitragen?](#wie-kann-ich-beitragen)
- [Fehler melden](#fehler-melden)
- [Neue Grüßfunktion vorschlagen](#neue-grüßfunktion-vorschlagen)
- [Code-Beiträge](#code-beiträge)
3. [Entwicklungsumgebung einrichten](#entwicklungsumgebung-einrichten)
4. [Ablauf für Pull Requests](#ablauf-für-pull-requests)
5. [Community](#community)
6. [Lizenz](#lizenz)

## Verhaltenskodex

Dieses Projekt und alle Teilnehmer daran unterliegen unserem [Verhaltenskodex](CODE_OF_CONDUCT.md). Durch die Teilnahme wird erwartet, dass du diesen Kodex einhältst. Bitte melde unangemessenes Verhalten an [Projekt-E-Mail, falls vorhanden].

## Wie kann ich beitragen?

### Fehler melden

Wenn du auf einen Fehler stößt, erstelle bitte ein Issue in unserem [Issue-Tracker](Link zu deinem Issue-Tracker) mit einer detaillierten Beschreibung des Problems, den Schritten zur Reproduktion und allen relevanten Informationen.

### Neue Grüßfunktion vorschlagen

Hast du eine Idee für eine neue Grüßfunktion? Super! Reiche ein Issue in unserem [Issue-Tracker](Link zu deinem Issue-Tracker) mit deinem Vorschlag und allen zusätzlichen Kontextinformationen ein.

### Code-Beiträge

Wir freuen uns über Code-Beiträge! Wenn du Code beisteuern möchtest, befolge bitte diese Schritte:

1. Fork das Repository.
2. Erstelle einen neuen Branch für deine Funktion oder Fehlerbehebung.
3. Implementiere deine Änderungen.
4. Füge Tests für deine Grüßfunktion hinzu.
5. Führe die Tests aus.
6. Aktualisiere die Dokumentation.
7. Reiche einen Pull Request ein.

## Entwicklungsumgebung einrichten

Um eine Entwicklungsumgebung einzurichten, befolge diese Schritte:

1. Klone das Repository.
2. Installiere die Abhängigkeiten (`npm install`, `pip install -r requirements.txt`, etc.).
3. [Zusätzliche Schritte, falls vorhanden.]

## Ablauf für Pull Requests

Bevor du einen Pull Request einreichst, stelle sicher, dass du den [Leitfaden für Code-Beiträge](CONTRIBUTING.md) befolgt hast.

1. Stelle sicher, dass deine Grüßfunktion den Codierungsstandards entspricht.
2. Füge Tests für deine Grüßfunktion hinzu.
3. Aktualisiere die Dokumentation, um deine Grüßfunktion zu reflektieren.
4. Stelle sicher, dass der Testlauf erfolgreich ist.
5. Reiche den Pull Request ein.

## Community

- Trete unserer Community auf [Link zu deiner Community-Plattform] bei.
- Folge uns auf [Social Media-Links, falls vorhanden].

## Lizenz

Durch die Mitarbeit an say-hello-functions stimmst du zu, dass deine Beiträge unter der [LIZENZ] Lizenz stehen.

---

Vielen Dank für deine Mitarbeit!

0 comments on commit 69f07f9

Please sign in to comment.