Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (42 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 1.34 KB
Raw

Contributing / Beitragen

Thanks for your interest in improving this project.

English

Before You Start

  • Keep changes simple and easy to explain.
  • Avoid large unrelated refactors.
  • Open an issue first for bigger changes.

Setup

  1. Fork and clone the repository.
  2. Run the quality gate:
./scripts/run_checks.sh
  1. Open model/bicycle_model.html in a browser for manual checks.

Development Rules

  • Keep plain HTML/CSS/vanilla JavaScript style.
  • Prefer small, reviewable commits.
  • Add or update tests for behavior changes.
  • Update relevant docs when behavior changes.

Pull Request Checklist

  • Tests pass locally (./scripts/run_checks.sh)
  • Scope is focused
  • Docs updated
  • No secrets or credentials added
  • Manual browser check completed

Deutsch

Bevor Du Startest

  • Änderungen einfach und nachvollziehbar halten.
  • Keine großen, fachfremden Refactorings.
  • Für größere Änderungen zuerst ein Issue öffnen.

Setup

  1. Repository forken und klonen.
  2. Prüfschleife ausführen:
./scripts/run_checks.sh
  1. model/bicycle_model.html im Browser manuell prüfen.

Regeln Für Änderungen

  • Plain HTML/CSS/Vanilla JavaScript beibehalten.
  • Kleine, gut reviewbare Commits bevorzugen.
  • Bei Verhaltensänderungen Tests ergänzen/anpassen.
  • Relevante Doku mitpflegen.