Awesome that you would like to contribute! This is a small document to help you getting started with your contribution.
SBT Native Packager provides packaging support for a variety of operating systems, packaging types, systemloader and service types. Sometimes this means a pull request may take a bit longer, because testing is sometimes hard and tedious.
Most of the changes are of a very small nature, but can have a huge impact, so try to cover the three topis Code, Documentation and Test :)
We have a lot of different languages and DSLs:
Make sure to run sbt compile
before opening a pull request. This will format
the sourcecode according to our standards
Provide the bash version you tested your code with.
Provide the environment you tested your bat file; windows version, cmd, powershell.
If you add or change the behaviour of a task or setting provide a small documentation
for it. The documentation can be found in src/sphinx
.
Build the documentation with
~sphinx:generateHtml
For more details see the Developer Guide
If you fix a bug or introduce a new feature, provide a test for it. You can run the tests for
$ sbt
> scripted universal/* debian/* rpm/*
$ sbt
> scripted windows/*
$ sbt
> scripted docker/*