Skip to content

Commit 170f8ca

Browse files
committed
update contributing section
1 parent 9271b34 commit 170f8ca

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,42 +20,48 @@ See the ["About" writeup](https://github.com/cmu-delphi/forecast-eval/blob/f12ab
2020

2121
# Contributing
2222

23-
1. Create a new branch off of `dev`
24-
2. Create a pull request into `dev`
23+
`main` is the production branch and shouldn't be directly modified. Pull requests should be based on and merged into `dev`. When enough changes have accumulated on `dev`, a release will be made to sync `main` with it.
2524

26-
**Note:** the easiest way to view and develop this project locally is to use RStudio and run the RShiny app from inside the IDE
25+
This project requires a recent version of GNU `make` and docker.
26+
27+
The easiest way to view and develop this project locally is to run the Shiny app from RStudio:
2728

2829
<img width="1111" alt="Screen Shot 2021-08-30 at 10 56 59 AM" src="https://user-images.githubusercontent.com/14190352/131359925-3b460d21-b9aa-4a40-a691-cd705ab98431.png">
2930

30-
Alternatively, ...
31+
This is the same as running
3132

33+
```R
34+
shiny::runApp("<directory>")
35+
```
3236

33-
## Building
37+
in R. However, dashboard behavior can differ running locally versus running in a container (due to package versioning, packages that haven't been properly added to the container environment, etc), so the dashboard should be also tested in a container.
3438

35-
This project requires a recent version of GNU make and docker.
39+
The dashboard can be run in a Docker container using `make`. See notes in the Makefile for workarounds if you don't have image repository access.
3640

37-
Builds use a containerized R environment. See the `docker_build` directory for more details.
41+
The pipeline can be run locally with the `Report/create_reports.R` script and in a container. See notes in the Makefile for workarounds if you don't have image repository access.
3842

39-
To build:
43+
## Running the scoring pipeline
4044

41-
```bash
42-
> make build
43-
```
45+
The scoring pipline use a containerized R environment. See the `docker_build` directory for more details.
4446

45-
To start `bash` shell in the docker container, which would let you start an R session:
47+
The pipeline can be run locally with the `Report/create_reports.R` script and in a container via
4648

4749
```bash
48-
> make start_repl
50+
> make score_forecast
4951
```
5052

51-
## Starting a local shiny server
53+
See notes in the Makefile for workarounds if you don't have image repository access.
54+
55+
## Running the Shiny app
5256

53-
To start a docker image of the shiny server locally:
57+
The dashboard can be run in a Docker container using
5458

5559
```bash
5660
> make start_dashboard
5761
```
5862

63+
See notes in the Makefile for workarounds if you don't have image repository access.
64+
5965
# Releasing
6066

6167
`main` is the production branch and contains the code that the public dashboard uses. Code changes will accumulate on the `dev` branch and when we want to make a release, `dev` will be merged into `main` via the ["Create Release" workflow](https://github.com/cmu-delphi/forecast-eval/blob/f12ab6f303ba81d6cbc32d61720061474496a00f/.github/workflows/create_release.yml). Version bump type (major, minor, etc) is specified manually when running the action.

0 commit comments

Comments
 (0)