Please feel free to help us with the ongoing development of this app. See open issues to get some inspiration and open a Pull Request as soon as you are ready to go.
Some issues are tagged with 🐶beginner friendly to get you started!
Clone the git repository:
git clone --recursive https://github.com/schul-cloud/schulcloud-mobile-android
You first need to start a new branch. As a base you can either choose the dev branch, or another issue-branch that was recently developed but not yet merged. You should normally choose the former, except there is a super cool new feature which you want to improve. However, don't base your branch on master, as it contains the latest stable release and might be outdated.
To name your branch, take the number of the Jira-issue and append the issue name in lowercase, replacing spaces with dashes.
Example: Issue AN-2, "Add styleguide for coding" becomes branch 2-add-styleguide-for-coding
We have documented the underlaying architecture of our app in the architecture file. It also contains code snippets for common features, such as embedding a SwipeRefreshLayout with only three lines of code or showing a progress dialog with just one line.
When commiting, please use conventional commits. This makes it much easier to get an overview of what you did.
Before you create a pull request, please enter a short description of what changed in our changelog (Unreleased section).
For writing the PR message and details on what to include, please use our Pull Request template.