Skip to content

Latest commit

 

History

History
13 lines (7 loc) · 626 Bytes

CONTRIBUTING.md

File metadata and controls

13 lines (7 loc) · 626 Bytes

How to contribute

Welcome

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guides for contributing and feel free to propose changes to this document in a pull request.

Happy to have you onboard 👍

How to update the README.md

The README is generated using mdoc from the README source so that all code examples are compiled, run, and its output added to the code block. When updating the README the source needs to be updated, which can be found in /docs/. Then one needs to regenerate the README using the sbt:root> docs/mdoc command.