Skip to content

Latest commit

 

History

History
24 lines (14 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

24 lines (14 loc) · 1.79 KB

Contributing to LoxBerry

Thanks for taking time to read our contribution tips! 🎉👍

We have released LoxBerry Version 1.0 (formerly known as 0.3.x saruman) that brings LoxBerry Update, an automatic update feature, to the users. This means - every changes needs to be tested well and every new feature should not break others, as the update directly sources from our GitHub repository.

The current development branch is master. Pull any change requests to the master repository. We do not merge any code to to other branches - especially older branches - anymore.

To get a good basis to start surfing code, test and develop, you should install the latest LoxBerry 1.0 image. You'll find the images on https://download.loxberry.de. Then, use LoxBerry Update to update your LoxBerry to the Latest commit.

It is a good idea to browse the issues - also issues already closed (remove the is:open filter) to see where the journey goes.

We "excessively" use labels in issues. The 'bug' label needs to be fixed definitely. The 'enhancement' is a user story that we try to catch, but if it has 'must have' we really will do it for 1.0.

Some of our issues we additionally have labelled with 'good first issue'. We thing this are parts that new developers could achieve also without knowing the entire system.

We hardly accept Pull requests that change current functionality of the files in /libs as they are part of the SDK and are used from all system widgets and plugins. Please drop us a note, if you want to change these libs.

If you have any questions, give us a message on Github or inside an issue. If you speak German, our disussion base is an own area in LoxForum: https://www.loxforum.com/forum/projektforen/loxberry/entwickler

Thank you and we are awaiting your first pull request! :)