PowerUp - Android
PowerUp is a female empowerment educational mobile game app that will allow young girls to learn about reproductive health and self-esteem by navigating the life of their avatar!
Setup for Developers
- Make sure you have downloaded the latest version of Android Studio. It works on Linux, Windows and Mac. Download the correct version for your OS
- Go to the project repo and fork it by clicking "Fork"
- If you are working on Windows, download Git Bash for Windows to get a full Unix bash with Git functionality
- Clone the repo to your desktop
git clone [email protected]:your_name/powerup-android.git
- Open the project with Android Studio
When a repository is cloned, it has a default remote called
origin that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named
Open terminal or git bash in your local repository and type:
git remote add upstream https://github.com/systers/powerup-android.git
git remote -vto check the status, you should see something like the following:
origin https://github.com/YOUR_USERNAME/powerup-android.git (fetch)
origin https://github.com/YOUR_USERNAME/powerup-android.git (push)
upstream https://github.com/systers/powerup-android.git (fetch)
upstream https://github.com/systers/powerup-android.git (push)
To update your local copy with remote changes, run the following:
git fetch upstream
git merge upstream/master
This will give you an exact copy of the current remote, make sure you don't have any local changes.
Contributing and developing a feature
- Make sure you are in the master branch
git checkout master
- Sync your copy
- Create a new branch with a meaningful name
git checkout -b branch_name
- Develop your feature on Android Studio and run it using the emulator or connecting your own Android device
- Clean your project from Android Studio
- Add the files you changed
git add file_name(avoid using
git add .)
- Commit your changes
git commit -m "Message briefly explaining the feature"
- Keep one commit per feature. If you forgot to add changes, you can edit the previous commit
git commit --amend
- Push to your repo
git push origin branch-name
- Go into the Github repo and create a pull request explaining your changes
- If you are requested to make changes, edit your commit using
git commit --amend, push again and the pull request will edit automatically
- You will need to add a message on the pull request notifying your changes to your reviewer
Documentation of PowerUp (Android)
Here's the link to the official documentation: Visit Documentation!
- Don't use magic numbers or hard-coded strings. Put them in dimens.xml or strings.xml
- Class names should be in CamelCase. Name activities with names including Activity so it's easier to know what they are.
- Include spaces between parameters when you call a method for example:
- Give relevant names to buttons and other resources.
@+idwhen referring to resources that have been already created in xml files.