Using Github with ED2

Setting up (first time)

Before any work is done:

1. First fork pecan on github into your own github space (github help: "fork a repo")

2. Introduce yourself to GIT

    git config --global user.name "FULLNAME"
    git config --global user.email [email protected]
   

3. If you are working from a cluster, you may need to set up ssh keys

4. Clone to your local machine

git clone [email protected]:<username>/ED2.git

5. Define upstream

git remote add upstream [email protected]:EDmodel/ED2.git

Daily usage

1 - Get the latest code from the main repository

git pull upstream master

2 - Do some coding

3 - Commit after each chunk of code (multiple times a day)

git commit -m "<some descriptive information about what was done>"

4 - Push to YOUR Github (when a feature is working, a set of bugs are fixed, or you need to share progress with others)

git push origin <branchname>

5 - Before submitting code back to the main repository, make sure that code compiles

./scripts/build.sh -c

6 - submit pull request (see github documentation)