-
Notifications
You must be signed in to change notification settings - Fork 1
Getting Started
Jonas Wanke edited this page Jun 6, 2019
·
1 revision
- Contact @Jonas Wanke (@JonasWanke) on Telegram and ask him to add you to the Mobile Dev-Club group on GitHub
- Accept the invitation via github.com/HPI-de
- Follow the setup guide: github.com/HPI-de/hpi-android/wiki/Setup
And you're done! Don't forget to leave a star ;)
An overview of the architecture is available in this wiki: github.com/HPI-de/hpi-android/wiki/Architecture
To start working on an issue, call the following in the command line (replacing by the ID of your issue):
unicorn issue assign <id>
Types:
- feat: added feature
- fix: fixed bug - add a test to prevent it from happening again!
- refactor: refactored some code to have a (better) architecture - no functional changes!
- ui: added or changed UI related things (mostly small improvements - use "feat" for bigger changes)
- docs: added documentation
- perf: improved performance
- (build: changed configuration (e.g. gradle or CI))
- (chore: generated by the CI, not important for you)
Scopes: the module name(s), e.g. core, app, news, course, etc.
Body and footer can be left blank, but please enter a meaningful description (in present tense).
When doing pair programming: you can add the second author by using
- GitHub Desktop's "Add co-authors" feature
- or add another line "Co-authored-by: Git Name [email protected]" in the message body
When you're done with this issue, call (replacing with a conventional commit-style description of the complete work you did): unicorn issue complete "<description>"