Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
sheilasaia opened this issue Jul 11, 2019 · 5 comments
Open

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

sheilasaia opened this issue Jul 11, 2019 · 5 comments

Comments

@sheilasaia
Copy link
Collaborator

sheilasaia commented Jul 11, 2019

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
Copy link
Collaborator Author

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

@sheilasaia
Copy link
Collaborator Author

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

@clnsmth
Copy link
Member

clnsmth commented Aug 7, 2019

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
Copy link
Member

clnsmth commented Oct 1, 2019

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
Copy link
Member

clnsmth commented Oct 1, 2019

Manual testing protocol:

  • Use sample data and quickly check that each tab is populated with expected content. In depth testing of UI functionality is done in the next step.
  • Load data from DOI (doi:10.6073/pasta/b66da575549dcfe19dc404949613049b)
    • Exercise all functionality available in each tab of the UI and evaluate whether it's responding as expected.

@sheilasaia sheilasaia changed the title how to make changes to the EDI Hackathon code how to load and make changes to the EDI Hackathon code Oct 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants