Skip to content
This repository has been archived by the owner on May 20, 2024. It is now read-only.

Latest commit

 

History

History
36 lines (23 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 2.35 KB

Beitragshinweise für das Projekt MR-Tutoring

Vielen Dank für Ihr Interesse an der Mitarbeit an MR-Tutoring. Wir schätzen Ihre Hilfe bei der Verbesserung unseres Projekts. Bitte lesen Sie diese Beitragshinweise sorgfältig durch, bevor Sie mit dem Beitrag beginnen.

Issue-Erstellung

  • Bevor Sie an einem Beitrag arbeiten, überprüfen Sie bitte die vorhandenen Issues, um sicherzustellen, dass Ihr Beitrag nicht bereits bearbeitet wird oder bereits ein Issue für das Problem besteht, das Sie beheben möchten.

  • Wenn kein Issue für Ihr Problem existiert, erstellen Sie bitte ein neues Issue, um es zu beschreiben. Geben Sie eine klare Beschreibung des Problems, Ihrer Lösung oder des gewünschten Features.

Beitragsprozess

  1. Forken Sie dieses Repository in Ihren GitHub-Account.
  2. Erstellen Sie einen neuen Branch in Ihrem Fork für Ihre Änderungen. Benennen Sie den Branch beschreibend, z. B. feature/neues-feature oder bugfix/behebung-eines-bugs.
  3. Arbeiten Sie in Ihrem Branch an Ihren Änderungen.
  4. Stellen Sie sicher, dass Ihr Code den Coding-Standards und den Qualitätsrichtlinien des Projekts entspricht.
  5. Aktualisieren Sie gegebenenfalls die Dokumentation, wenn Ihre Änderungen dies erfordern.
  6. Erstellen Sie ein Pull-Request (PR) in dieses Repository.

Pull-Request (PR) Richtlinien

  • Geben Sie eine klare Beschreibung des Pull-Requests ab, einschließlich der Zweck Ihrer Änderungen.
  • Verknüpfen Sie den PR mit dem zugehörigen Issue, wenn vorhanden.
  • Ihr PR sollte nur die notwendigen Änderungen enthalten, um das Problem zu beheben oder das Feature hinzuzufügen.
  • Achten Sie darauf, eventuelle Konflikte mit anderen Branches zu lösen, bevor Sie den PR einreichen.

Code-Rezension

  • Der Code wird von den Maintainers des Projekts überprüft. Sie können Feedback und Anmerkungen geben, um die Qualität und Lesbarkeit des Codes sicherzustellen.
  • Änderungen am Code oder in der Dokumentation können vorgenommen werden, um sicherzustellen, dass sie den Projektstandards entsprechen.

Lizenz

Indem Sie einen Beitrag zu diesem Projekt leisten, stimmen Sie zu, dass Ihre Beiträge unter der Lizenz des Projekts veröffentlicht werden.

Vielen Dank für Ihre Unterstützung und Ihre Beiträge zu MR-Tutoring! Ihre Mitarbeit ist sehr willkommen, und wir freuen uns darauf, zusammenzuarbeiten, um dieses Projekt zu verbessern.