fork_and_clone.md

For a detailed explanation of the fork-and-clone process, please see this GitHub help page.

Fork and clone the Oppia Android repository

To make code changes, please follow the following instructions

• Using the terminal
• Using android studio's UI based github workflow

Using the terminal

1. Make sure that you are in the opensource/ folder on your local machine.

2. Click on the "Fork" button on the top-right corner (at the same level as the oppia/oppia-android repository name):

3. You can now see Oppia-Android under your repositories. It will be marked as forked from oppia/oppia-android

4. Clone this repository to your local computer by running git clone https://github.com/USERNAME/oppia-android.git in a terminal.

5. To keep your local repository, forked repository and main oppia-android repository in sync, configure your remote repositories by running the following two commands in a terminal:

   • git remote -v (this lists your current remote repositories)
   • git remote add upstream https://github.com/oppia/oppia-android (this adds oppia/oppia-android as an upstream repo)

Using android studio's UI based github workflow

1. Navigate to your fork, e.g. https://github.com/<your_username>/oppia-android. Click on Clone or download and copy the link (the URL will look different since you should be using your fork, not https://github.com/oppia/oppia-android).

2. Now, go to Android Studio>File>New>Project from Version Control>Git

3. Log in GitHub with your credentials.

4. Paste the URL and click on Clone button. Wait for a few minutes until Gradle build completes.