A base project to fast track mobile development.This project is setup to implement the Model-View-Presenter architecture for mobile development, it is also suggested to follow the packaging by feature style of structure.
Guide to contributing to CottaCush Android Projects
To Setup CheckStyle for Already existing projects kindly follow the instructions below:
-
cd to the root directory of your project
-
do
mkdir config && cd "$_"
( You can also domkdir config
then subsequentlycd config
or whichever way is convenient for you to create the config directory and cd into it) -
do
curl -L -O https://link/to/raw/baseproject/checkstyle.xml
andcurl -L -O https://link/to/raw/baseproject/prepush-checks.sh
to download the checkstyle and prepush script respectively into your config directory. -
In your
app/build.gradle
file, add the lineapply from: '../config/quality.gradle'
at the top just belowapply plugin: 'com.android.application'
-
In your project's
build.gradle
file, add the checkstyle dependency'com.puppycrawl.tools:checkstyle:7.1.2'
-
In your root directory do
chmod u+x config/prepush-checks.sh
-
Then do
ln -s $PWD/config/prepush-checks.sh .git/hooks/pre-push
To Setup CheckStyle for fresh projects that are offsprings of this baseproject's post-lint era (i.e have the scripts in the appropriate directory)
-
In your root directory do
chmod u+x config/prepush-checks.sh
-
Then do
ln -s $PWD/config/prepush-checks.sh .git/hooks/pre-push
Subsequently git pushes to the master repo will either fail or pass. For failed pushes find the issues at <path-to-repo/app/build/reports/checkstyle/checkstyle.xml
and handle accordingly