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

    $ git clone https://github.com/your-username/BetterPracticesInAndroid.git
  • Create a branch

    $ git checkout -b branch-name
  • Make your changes

  • Commit and Push

    $ 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

Additional References Added By Contributors

Licensing

This repo is licensed under GNU General Public License v3.0. See LICENSE for the full license text.