Skip to content

Commit

Permalink
Added explicit mentions to sbt that seemed missing (zio#2376)
Browse files Browse the repository at this point in the history
  • Loading branch information
FunkyFunctor-Chris authored and ghostdogpr committed Dec 1, 2019
1 parent bdf63b5 commit 6340079
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,19 +142,25 @@ git commit -am "merged upstream changes"
At this point, you should re-run all tests to make sure everything is passing:

```bash
test
# If you are already in a SBT session you can type only 'test'

sbt test
```

If all the tests are passing, then you can format your code:

```bash
fmt
# If you are already in a SBT session you can type only 'fmt'

sbt fmt
```

If your changes altered an API, then you may need to rebuild the microsite to make sure none of the (compiled) documentation breaks:

```bash
docs/docusaurusCreateSite
# If you are already in a SBT session you can type only 'docs/docusaurusCreateSite'

sbt docs/docusaurusCreateSite
```

(If you get an error about _Jekyll_, that means all the code examples work and you can ignore the rest.)
Expand Down

0 comments on commit 6340079

Please sign in to comment.