ribot/android-guidelines

Architecture and code guidelines we use at ribot when developing for Android

Thank you for your interest in ribot’s development work. Unfortunately there are no current plans to make any changes to this project in the near future, and it is not being maintained or updated. We hope you still find this a useful resource and you can check out the newest recommendations in Android Jetpack for more ideas!

Android Guidelines

List of guidelines that we use at ribot when developing for the Android platform.

• Project and code style guidelines
• Architecture Guidelines

License

Copyright 2015 Ribot Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

android-guidelines's Issues

Event Bus Example

Could either this repo or the boiler plate repo include an example of how to properly use an event Bus following these guidelines? If there's already one there could someone point it out?

Missing License

We would like to use and expand these guidelines, unfortunately it is lacking a license so we can't do that legally.
Can you please add an OSS license like MIT or Apache?

[Documentation] add names for resources navigation

I was reviewing the documentation and I see that it would be necessary to add a naming section in the navigation resources such as nav_graph and the name of the navigation

Model interacts with View

I wondering, it is OK, that your Model interacts with View through events? According to Wikipedia, the Model should interact with Presenter, that interacts with View.
https://en.m.wikipedia.org/wiki/File:Model_View_Presenter_GUI_Design_Pattern.png

Use this project as "Template repository" on Github.

The new feature "Template repository" is available on Github. Go to settings and check that option.

Android_project_guidelines

Guideline about generic exceptions is misleading

Just FYI - The code guidelines comment about not catching generic exceptions actually refers to a link in the Android OS source guidelines. That is, it is a guideline about writing the operating system code, not generic Android applications.

It is appropriate to catch generic exceptions in your code in many places, such as the bottom of a network library's main entry or the loop of a game. Even the Android OS will catch Throwables at the bottom of their message loops; they just don't want a random developer to prevent those Throwables from not reaching said loops.

Otherwise, this guideline is encouraging application crashes for unknown errors.

That being said... it is an appropriate guideline that an Android application should not catch generic exceptions except at the "bottom" of such locations, and not in most places (to be fair, the example given is a good example of when not to catch generic exceptions).

[Documentation] Project and Code guidelines incorrect numbering

Skipped:

• 2.2.2
• 2.2.12

Is it possible to inject RetrofitServie into Application instance?

public class RymeApplication extends Application{
@Inject
RymeService mRymeService;
=>and use it onCreate()
possible?

What about item name in MENU files?

What about item(android:id) names in menu files?

Ex.: res/menu/activity_main.xml

<?xml version="1.0" encoding="utf-8"?>

<menu>
   <item android:id="@+id/HERE_IS_THE_NAME" android:title="@string/action_back"></item>
</menu>

?

Where should abstract methods go in terms of logical ordering?

Hello all

First, I am very thankful to those who wrote this guide, I have been looking to improve my coding standard and have been following this and thus far found it very useful .

I have a question regarding this section

https://github.com/ribot/android-guidelines/blob/master/project_and_code_guidelines.md#2210-class-member-ordering

Where should abstract method declarations go in relation to ordering
For example in a base activity class

public abstract class BaseActivity extends AppCompatActivity implements FragmentManager.OnBackStackChangedListener {

    public abstract String getScreenNameForAnalytics();

}

Thanks for reading

Ersen

[Documentation] Wrong method call (typo)

Hi,
In section 2.2.14 Arguments in Fragments and Activities from project_and_code_guidelines.md in the method getStartIntent(), you call:
intent.putParcelableExtra(EXTRA_USER, user);
it must be:
intent.putExtra(EXTRA_USER, user);

Thank you very much for this repo!.

Regards,
Guillermo

[Documentation] Add hyperlinks to the libraries mentioned

While going through the architecture-guidelines documentation, I noticed that only Retrofit is a hyperlink and others like RxJava and Event Bus are not. I think adding links to their respective repositories and/or documentation will be helpful for beginners while reading the guidelines.

I'd like to take this up and update the documentation.

ViewGroup as View.

In your picture there is a way to use ViewGroup as a MVP View.
https://github.com/ribot/android-guidelines/raw/master/architecture_guidelines/architecture_diagram.png
Is there any example how i can do it?
I want to know how i can inject presenter for such view and where attachView() and detachView() should be placed.
May i have Presenter inside my LinearLayout?