Contribution guidelines

At first - thanks for supporting this project, much appreciated!

To keep things clean and avoid chaos, please follow this simple branch workflow if you want help us developing the integration further.

Branch structure

    %%{init: {"themeCSS": ".edgeLabel, .edgeLabel p { font-size: 12px !important; line-height: 1.2 !important; background-color: transparent !important; } .labelBkg { background-color: transparent !important; } .edgeLabel rect { fill: transparent !important; opacity: 0 !important; }"}}%%

    flowchart TB

    main[":main<br/>Holds current release<br/><red>Locked - *NO* PR's!</red>"]
    develop[":develop<br/>Central mergepoint<br/>Fork from here"]

    main ~~~ develop
    develop -.->|New release version:<br/>FF merge only.| main

    develop_tom[":develop_tom<br/>working branch<br/>my changes go here"]
    develop_you[":your_branch_name<br/>create it from :develop<br/>your changes go here"]
    develop_someone[":develop_someone<br/>working branch<br/>changes go here"]
    develop_sometwo[":develop_sometwo<br/>working branch<br/>changes go here"]

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



    style main stroke:red,color:red
    style develop stroke:green,color:green
    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!!!