Skip to content

Commit

Permalink
docs: Add a note about compiled documentation to contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubjanecek committed Oct 16, 2019
1 parent 4f13cdf commit f45b34c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ Some of the reported problems can be automatically fixed by `fix`:
sbt fix
```

## Documentation

The project contains [compiled documentation](https://scalameta.org/mdoc) which is located in [example/src/main/mdoc](example/src/main/mdoc).
Please do update it with your changes and recompile it to check that everything is fine using the following command:

```bash
sbt example/mdoc
```

You should definitely recompile [mdoc] documentation

## Conventional Commits

The project uses [Conventional Commits](https://www.conventionalcommits.org) specification to have clear Git history and help with
Expand Down

0 comments on commit f45b34c

Please sign in to comment.