From 3e03673f4bf80c79ede2eeaa68445e336cc51597 Mon Sep 17 00:00:00 2001 From: "Shawn P. Serbin" Date: Fri, 10 Mar 2023 08:10:23 -0500 Subject: [PATCH] Updated instructions Added new instructions on the recommended way to setup a users git to track the addition of a new dataset within a custom branch in a forked repo --- Vignettes/How_to_add_a_dataset.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/Vignettes/How_to_add_a_dataset.md b/Vignettes/How_to_add_a_dataset.md index c0967cbf..6ac879c7 100644 --- a/Vignettes/How_to_add_a_dataset.md +++ b/Vignettes/How_to_add_a_dataset.md @@ -6,6 +6,36 @@ corresponds to each step outlined in this guide. An overview of the process and database organisation is presented [here](https://github.com/TESTgroup-BNL/gsti/blob/main/Overal_data_curation.pdf). +## Recommended github steps prior to the inclusion of a new dataset +1) Fork this github repo into your own github space + +2) Clone the forked repo onto your local machine + e.g. git clone git@github.com:TESTgroup-BNL/gsti.git + + OR + + e.g. gh repo clone TESTgroup-BNL/gsti + +3) Define the upstream repository + e.g. git remote add upstream git@github.com:TESTgroup-BNL/gsti.git + +4) Ensure you are starting with the "main" branch in your cloned repo and make sure its up to date: + e.g. git checkout main && git pull upstream main + +6) Create a new branch and give it a descriptive branch name + e.g. git checkout -b + +7) Work on your branch, commit changes, keep a changelog + +8) Push this branch to your github space + e.g. git push origin + +9) Submit a pull request + +10) After the PR is merged, delete the branch on github and locally + e.g. git push origin --delete + e.g. git branch -D + ## Creation of a Dataset folder Each dataset should be put into a folder named “Names\_Year” for example