Home

Contributing / Branch Workflow

At first - thanks for helping with this project, much appreciated!

To keep things clean and avoid chaos, please follow this simple branch workflow:

flowchart TB
    main[":main<br/>Current release<br/><red>Locked branch!</red>"]
    develop[":develop<br/>Central mergepoint<br/>Beta code"]

    develop_tom[":develop_tom<br/>working branch<br/>my changes here"]
    develop_wertzui[":develop_wertzui<br/>working branch<br/>changes here"]
    develop_someone[":develop_someone<br/>working branch<br/>changes here"]
    develop_you[":develop_you<br/>working branch<br/>your changes here"]

    main ~~~ develop
    develop -.->|PR's only accepted<br/>from develop| main

    develop <-.->|FF merge| develop_tom
    develop <-.->|PR's| develop_wertzui
    develop <-.->|PR's| develop_someone
    develop <-.->|Your PR's| develop_you

    style main stroke:red,color:red
    style develop_you stroke:green,color:green

Loading

Contributions: Step-by-step

• Fork this repository first
  Please fork the repository and do your work in your own copy.

• Create your own working branch
  Create your branch based on develop (select develop branch, then create your own working branch from it).

  git checkout develop
  git pull
  git checkout -b develop_yourname
  

• Keep your branch up to date
  Before opening or updating a PR, please sync your branch with the latest develop.

• Always create your pull request against develop
  All new features, fixes and experiments must go into develop first. The main branch is configured to auto-reject direct PR's.

• Please enable editable pull requests
  When opening the PR, keep Allow edits by maintainers enabled. This makes it much easier to help with small fixes, cleanup or merge conflicts.

• Keep your branch focused
  One topic per pull request is much easier to review than one huge mixed change.

• Short description helps a lot
  Please briefly describe what you changed, why you changed it, and whether you already tested it.

And again: Thank you for contributing!!!