Skip to content

Commit

Permalink
Updated instructions
Browse files Browse the repository at this point in the history
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
  • Loading branch information
Shawn P. Serbin authored Mar 10, 2023
1 parent 982e342 commit 3e03673
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions Vignettes/How_to_add_a_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <branchname>

7) Work on your branch, commit changes, keep a changelog

8) Push this branch to your github space
e.g. git push origin <branchname>

9) Submit a pull request

10) After the PR is merged, delete the branch on github and locally
e.g. git push origin --delete <branchname>
e.g. git branch -D <branchname>

## Creation of a Dataset folder

Each dataset should be put into a folder named “Names\_Year” for example
Expand Down

0 comments on commit 3e03673

Please sign in to comment.