Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.98 KB

SETUP_GUIDELINES.md

File metadata and controls

33 lines (27 loc) · 1.98 KB
Raw

Steps for Developers

  1. Download the latest stable release of Android Studio.
  2. Fork the Project Repository by clicking "Fork".
  3. Clone the repository
    git clone https://github.com/YOUR_USERNAME/openfoodfacts-androidapp.git.
  4. Change directory cd openfoodfacts-androidapp.
  5. Run the project in Android Studio

Remote Configuration

After you clone the repository the default remote is origin and it refers to your fork on Github. You must keep track of the changes made to the original repository by setting up another remote named upstream.

  1. Open terminal in your repository and type
    git remote add origin https://github.com/YOUR_USERNAME/openfoodfacts-androidapp.git
  2. Type
    git remote add upstream https://github.com/openfoodfacts/openfoodfacts-androidapp
    to add upstream.
  3. Type git remote -v and you should see 
   origin  https://github.com/YOUR_USERNAME/openfoodfacts-androidapp.git (fetch)
   origin  https://github.com/YOUR_USERNAME/openfoodfacts-androidapp.git (push) 
   upstream        https://github.com/openfoodfacts/openfoodfacts-androidapp.git (fetch)
   upstream        https://github.com/openfoodfacts/openfoodfacts-androidapp.git (push)

To now update your local copy type
git fetch upstream
git merge upstream/master
git push

Steps for creating a Pull Request

  1. Checkout to the master branch git checkout master
  2. Sync git pull
  3. Start a new branch with a suitable name git checkout -b branch_name
  4. Develop a new feature or solve an existing issue
  5. Add the changed files git add file_name
  6. Commit with a suitable message git commit -m " Changes made "
  7. Push git push origin branch_name
  8. Go to the Github Repository and create a pull request according to the PULL_REQUEST_TEMPLATE.