Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add Contributing section to README #65

Merged
merged 2 commits into from
Aug 25, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,12 @@ using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) for la

Follow the installation instructions from the dsp-docs repository in order to build and serve the documentation locally.
Once the necessary software is installed you can use `mkdocs serve` for a live preview on http://127.0.0.1:8000/.

## Contributing

Our commit messages follow the [Conventional Commits Guidelines](https://www.conventionalcommits.org/en/v1.0.0/).

Source code must be formatted with `sbt fmt`.

Copyright headers must be added with `sbt headerCreateAll`.