Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.45 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.

Scanamo currently uses scalafmt to standardise code-style - the CI build will fail if formatting doesn't match the defined rules. You can get Scalafmt to reformat your code like this at the sbt prompt:

scalafmt
scalafmtSbt

...and you can check the changes are good with:

scalafmtCheck
scalafmtSbtCheck

Publishing a new release

This repo uses gha-scala-library-release-workflow to automate publishing releases (both full & preview releases) - see Making a Release.