IMCR-Hackathon / datapie

Data Package Interface for Evaluation ("Easy as pie!")
https://imcr-hackathon.github.io/datapie/
MIT License
3 stars 2 forks source link

how to load and make changes to the EDI Hackathon code #53

Open sheilasaia opened 5 years ago

sheilasaia commented 5 years ago

Please follow these steps when making changes to the EDI Hackathon code moving forward: (1) Make sure your master is up-to-date by using "git pull master". (2) Check that you have the development branch using "git branch", which will list all the branches you can modify (the current branch you are working on will have a little star in front of it). If you don't see the development branch listed run "git fetch" (this allows you to see the current state of the project without merging your version and the latest version, if they are different) and then "git branch" again. If you already have a the development branch, go to step 3. (3) Switch to the development branch by running "git checkout development". You can check that you switched to it by running "git branch" again and you're development branch should be starred (rather than the master). (4) Once switching to the development branch, make sure it's up-to-date by running "git pull". (5) Create and switch to your new personal development branch so you can start working on the issues assigned to you. To do this. run "git checkout -b sheila-development". Please change "sheila" to your name. ;) Alternatively, if you are working on a specific issue, you can also use that issue as the name, which has the added benefit of highlighting to others that you are working on that problem. (6) Make your additions and commits as you normally would (just now you're on your personal branch). (7) Push your new branch to GitHub using "git push -u origin sheila-development". Again, please change "sheila" to your name or whatever you named the new branch in step 5.

Once you're ready to merge your personal development branch with the team's development branch follow these steps: (8) Navigate to the development branch by running "git checkout development". Check you're there using "git branch". (9) Make sure you're development branch is up-to-date by running "git pull”. (10) Switch to your personal development branch by running "git checkout sheila-development" or whatever you named the branch in step 5 and check you’re on the branch by running "git branch". Then, merge your personal branch with the development branch by running "git merge development".

Jason also made a little diagram for those of you that are visual learners. Thanks, Jason!

GitWorkflow

sheilasaia commented 5 years ago

see #52 for sample code on how to run the app

sheilasaia commented 5 years ago

use "git fetch --track origin/" to download a remote branch on your local computer

clnsmth commented 5 years ago

Hi all,

A reminder that when developing/testing/using datapie make sure you're loading the package with devtools::load_all(".") from your datapie.Rproj RStudio Console. This produces the common workspace in which we are all developing and the common environment in which package users will operate. Failing to do this can create inconsistencies in the package code we are all working and makes convergence on a coherent code base very difficult.

@sheilasaia and I just found inconsistencies in the usage of dependency libraries that is leading to different results across branches. Do not customize the loading of libraries to make datapie run. If you have a dependency that is apart of datapie add it to the DESCRIPTION file, or tell me and I'll add it.

clnsmth commented 5 years ago

Until automated testing is implemented with sufficient coverage, we are opting for a manual test of datapie UI functionality. So, before merging your work into master, please contact me and @atn38 for approval. One of us will perform the tests and let you know if it's OK to merge.

clnsmth commented 5 years ago

Manual testing protocol: