Skip to content

Commit

Permalink
update the readme w/some new instructions + extra formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
shaneknapp committed Oct 22, 2024
1 parent 88a1853 commit 3103e2c
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,18 @@ or from links in the deployment's `image/README.md`
The `staging` branch always reflects the state of the [staging JupyterHub](http://staging.datahub.berkeley.edu),
and the `prod` branch reflects the state of the [production JupyterHub](http://datahub.berkeley.edu).

## Installing the required python packages for working with datahub

In the root directory of this repo, install `dev-requirements.txt` with the
following command: `pip install -r dev-requirements.txt`. This will install
the base python packages that are required to perform the tasks associated with
editing, testing, building and deploying hubs.

The other python package definition file, `requirements.txt` is used solely by
our Github Actions CI/CD pipeline.

## Setting up your fork and clones

First, go to your [github profile settings](https://github.com/settings/keys)
and make sure you have an SSH key uploaded.

Expand Down Expand Up @@ -59,29 +70,36 @@ git rebase upstream/staging && \
git push origin staging
```


## Procedure

When developing for this deployment, always work in a fork of this repo.
You should also make sure that your repo is up-to-date with this one prior
to making changes. This is because other contributors may have pushed changes
after you last synced with this repo but before you upstreamed your changes.

### Syncing your repo

The following commands will sync the local clone of your fork with `upstream`:
```
git checkout staging && \
git fetch --prune --all && \
git rebase upstream/staging && \
git push origin staging
```

To create a new branch and switch to it, run the following command:
### Creating a feature branch

To create a new feature branch and switch to it, run the following command:
```
git checkout -b <branch name>
```

### Checking the status and diffs of your local work

After you make your changes, you can use the following commands to see
what's been modified and check out the diffs: `git status` and `git diff`.

### Adding, committing and pushing changes

When you're ready to push these changes, first you'll need to stage them for a
commit:
Expand All @@ -99,6 +117,8 @@ Now push to your fork:
git push origin <branch name>
```

### Creating a pull request

Once you've pushed to your fork, you can go to the
[Datahub repo](https://github.com/berkeley-dsep-infra/datahub) and there
should be a big green button on the top that says `Compare and pull request`.
Expand Down

0 comments on commit 3103e2c

Please sign in to comment.