Skip to content

Latest commit

 

History

History
143 lines (97 loc) · 6.19 KB

CONTRIBUTING.md

File metadata and controls

143 lines (97 loc) · 6.19 KB
Raw

Contributing / Mitarbeit

Thank you for wanting to help out! Danke dass du mithelfen möchtest!

Die deutsche Übersetzung findest du weiter unten.

English

Code of conduct

Git setup

We use a triangular git workflow. This means that all changes are first pushed to a contributor's fork of the repository, and then the changes are merged into the main fork via a pull request. In practice, setting up this workflow looks as follows:

  1. Fork the main repository onto your GitHub account. Let's say your GitHub account is called your-username.

  2. Clone the main repository to your local computer:

    git clone https://github.com/ecamp/ecamp3.git
cd ecamp3

  3. Add your fork as a remote:

    git remote add your-username https://github.com/your-username/ecamp3.git

  4. Configure the central repo for pulling the current state and your own repo for pushing new changes:

    git config remote.pushdefault your-username
git config push.default current

Once this is set up, you can start coding, and all git pull commands should pull from the central repository by default, while all git push commands will push to your fork of the project.

Starting a new feature

Before starting a new feature, you should do the following steps to start with a clean state that is easily mergeable later:

git fetch --all
git checkout origin/devel
git checkout -b my-new-feature-branch

Code formatting

We use cs-fixer for PHP and ESLint and Prettier for Javascript to ensure a common code style. Make sure your code is auto-formatted before comitting and pushing to the repository.

We recommend to configure your IDE such that your code is auto-formatted on save.

Alternatively you can

  • run php-cs-fixer and ESLint / Prettier manually before each commit: 
    docker compose run api composer cs-fix
docker compose run frontend npm run lint
docker compose run print npm run lint
  • set-up a git pre-commit hook to run php-cs-fixer and ESLint automatically before each commit

Before submitting pull requests

  • Did cs-fixer run on all changed or new PHP files?
  • Did ESLint / Prettier run on all changed or new JS / Vue files?
  • Are all variables, classes, functions, comments etc. named or written in English?
  • Did you write tests for any new functionality or adapt the existing tests for changed functionality?
  • Are all passwords, credentials and local configuration removed from the code changes?
  • Do all changed files contain some important changes (as opposed to e.g. only whitespace changes)?
  • Is the fork up-to-date with the central repository and can your changes be merged automatically?
  • Did the GitHub Actions CI build run through without test failures?

Deutsch

Verhaltenskodex

Git einrichten

Wir wenden einen triangulären Git-Workflow an. Das bedeutet, dass alle Code-Änderungen zuerst auf dem Fork des Entwicklers veröffentlicht werden, und erst dann werden die Änderungen via Pull Request in das offizielle eCamp3-Repository eingefügt. Um dies einzurichten, befolgen wir folgende Schritte:

  1. Erstelle einen persönlichen Fork des zentralen Repositories auf GitHub. Nehmen wir an dein GitHub-Account heisst your-username.

  2. Klone das originale Repository auf deinen lokalen Computer:

    git clone https://github.com/ecamp/ecamp3.git
cd ecamp3

  3. Füge deinen Fork als Remote hinzu:

    git remote add your-username https://github.com/your-username/ecamp3.git

  4. Konfiguriere Git, sodass es als aktuellen, offiziellen Code-Stand das zentrale Repository und fürs Veröffentlichen neuer Änderungen den Fork verwendet:

    git config remote.pushdefault your-username
git config push.default current

Wenn dies eingerichtet ist kannst du loslegen, und alle git pull-Befehle sollten standardmässig den Code vom zentralen Repository holen und git push-Befehle sollten auf deinen eigenen Fork des Projekts senden.

Ein neues Feature beginnen

Bevor du etwas am Code änderst, solltest du jeweils die folgenden Schritte durchführen, um mit einem sauberen Stand zu starten der später einfach gemerged werden kann:

git fetch --all
git checkout origin/devel
git checkout -b my-new-feature-branch

Quellcode Formatierung

Wir verwenden php-cs-fixer für PHP und ESLint und Prettier für JS um einen gemeinsamen Code Style zu etablieren. Bitte stelle sicher, dass dein Code automatisch richtig formatiert wird, bevor du diesen ins Git repo committest.

Wir empfehlen deine IDE so zu konfigurieren, dass dein Code beim Speichern automatisch richtig formatiert wird.

Alternativ kannst du

  • php-cs-fixer und ESLint / Prettier vor jedem commit manuell laufen lassen: 
    docker compose run api composer cs-fix
docker compose run frontend npm run lint
docker compose run print npm run lint
  • einen git pre-commit hook einrichten, der php-cs-fixer und ESLint vor jedem commit triggert

Vor dem Einreichen eines Pull Requests

  • Wurden alle geänderten oder neuen PHP-Dateien von cs-fixer verarbeitet?
  • Wurden alle geänderten oder neuen JS/Vue-Dateien von ESLint / Prettier bereinigt?
  • Sind alle Variabeln, Klassen, Funktionen, Kommentare, etc. auf englisch benannt?
  • Hast du für neue Funktionalität Tests geschrieben und für geänderte Funktionalität die Tests angepasst?
  • Wurden alle Passwörter, Zugangsdaten und lokale Konfiguration aus den Code-Änderungen entfernt?
  • Enthalten alle geänderten Dateien auch wirklich eine sinnvolle Änderung (im Gegensatz zu z.B. nur Whitespace-Änderungen)?
  • Ist der Fork auf dem aktuellen Stand des zentralen Repositories und können die Änderungen automatisch gemerged werden?
  • Ist der GitHub Actions CI-Build erfolgreich und ohne Test Failures durchgelaufen?