Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 1.61 KB

If you have a question about Scanamo there is a Gitter channel to try and answer it. Suggestions on how to improve the documentation are very welcome.

Feel free to open an issue if you notice a bug or have an idea for a feature.

Pull requests are gladly accepted. Scanamo follows a standard fork and pull model for contributions via GitHub pull requests.

Building and testing Scanamo

Scanamo uses a standard SBT build. If you have SBT installed, you should first run startDynamodbLocal task from the SBT prompt to start a local dynamodb instance and afterwards run the test command to compile Scanamo and run its tests.

Most, though not all of Scanamo's tests are from examples in the scaladoc, or README.md, which are turned into tests by sbt-doctest.

Contributing documentation

The website is built using sbt-microsites. To check documentation changes:

  • Make sure jekyll is installed locally
  • run makeMicrosite from the root of SBT
  • run jekyll serve --incremental --baseurl / from docs/target/site
  • Load http://127.0.0.1:4000/

Releasing

release cross from the SBT prompt should publish an artifact to Maven Central for both Scala 2.11 and Scala 2.12. It will also attempt to update the documentation website at http://www.scanamo.org/ with the latest scaladoc.