FastHub/CONTRIBUTE.md
2017-02-25 14:22:53 +08:00

28 lines
924 B
Markdown

# How to contribute & build *FastHub*
### Before you import the project to Android Studio:
- Make sure you have Android Studio 2.3 & above.
- Import Android Studio Settings (to ensure same code formatting) from this link [Click here](https://raw.githubusercontent.com/k0shk0sh/FastHub/master/fasthub_as_settings.jar)
- Install Lombok Plugin from Android Studio Plugins & enable Annotations Processors from (Android Studio Preference).
- Install SqliteMagic Plugin from Android Studio Plugins.
### After above steps:
- Fork the project.
- Clone it to your desktop.
- Open the project from Android Studio.
- Let it build & Start coding.
### Submitting PR
> Please make sure your commit messages are meaningful.
- Create new Branch with the feature or fix you made.
- Submit your PR with an explanation of what you did & why (~~if applicable~~).
> I really appreciate your efforts on contributing to this project.