https://github.com/codermasum/BetterPracticesInAndroid
https://github.com/codermasum/BetterPracticesInAndroid
android architecture-components dagger2 firebase-database firestore java kotlin mvi-architecture mvp-architecture mvvm-architecture retrofit2 room-persistence-library rxjava2 xml
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/codermasum/BetterPracticesInAndroid
- Owner: codermasum
- License: gpl-3.0
- Created: 2019-10-01T07:47:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-01T09:43:48.000Z (over 6 years ago)
- Last Synced: 2024-10-24T15:38:01.950Z (over 1 year ago)
- Topics: android, architecture-components, dagger2, firebase-database, firestore, java, kotlin, mvi-architecture, mvp-architecture, mvvm-architecture, retrofit2, room-persistence-library, rxjava2, xml
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Better Practices In Android
This is an open source project to help developers to build better Android Apps. This repo will be a reference guide for developers to write
clean, reusable, optimized code for making smooth user experience app followed by Google's guidelines for Android.
# How To Contribute to This Project
Here ia a quick and painless steps to contribute to this project:
* Add your code in any Java/Kotlin language, under specific directories.
* You can also refer your blog, note that a small 'description.md' file should be added.
To do so, first create an issue with the task you are doing, for example: "Issue - creating test for LiveData".
Add the `HacktoberFest` label in the issue and assign the issue to yourself. Create a pull request in response
to that issue and finally submit it for review.
* Name your branch `username_yourtopicName`.
Also create a directory for any new features/code if it doesn't exist.
Inside these directories you can create your own file named `program_name.language_extension` (`hello_world.kt`)
Create a commit of the form - fixes #(issue_number)
* Finally, wait for it to be merged!
## Getting Started
* Fork this repository (Click the Fork button in the top right of this page, click your Profile Image)
* Clone your fork down to your local machine
```sh
$ git clone https://github.com/your-username/BetterPracticesInAndroid.git
```
* Create a branch
```sh
$ git checkout -b branch-name
```
* Make your changes
* Commit and Push
```sh
$ git add filename
$ git commit -m 'commit message'
$ git push origin branch-name
```
* Create a New Pull Request from your forked repository (Click the New Pull Request button located at the top of your repo)
* Wait for your PR review and merge approval!
* __Star this repository__ if you had fun!
Don't forget to include the comments as seen above. Feel free to include additional information about the language you chose in your comments too! Like a link to a helpful introduction or tutorial.
## Reference Links
* [Managing your Forked Repo](https://help.github.com/articles/fork-a-repo/)
* [Syncing a Fork](https://help.github.com/articles/syncing-a-fork/)
* [Keep Your Fork Synced](https://gist.github.com/CristinaSolana/1885435)
* [Github-Flavored Markdown](https://guides.github.com/features/mastering-markdown/)
## Additional References Added By Contributors
* [GitHub license explained](https://choosealicense.com)
## Licensing
This repo is licensed under GNU General Public License v3.0. See [LICENSE](https://github.com/Jnerdva/BetterPracticesInAndroid/blob/master/LICENSE) for the full license text.