We follow the standard GitHub fork & pull approach to pull requests. Just fork the official repo, develop in a branch, and submit a PR!
You're always welcome to submit your PR straight away and start the discussion (without reading the rest of this wonderful doc, or the README.md). The goal of these notes is to make your experience contributing to this project as smooth and pleasant as possible. We're happy to guide you through the process once you've submitted your PR.
You need to have a JDK and sbt installed on your machine.
This project contains only a single module, sbt-version-policy. Its
sources are under src/, at the root of the project.
The sources of the sbt plugin itself live under src/main.
Some unit tests can be found under src/test.
src/sbt-test contains scripted tests, that test the plugin against actual sbt projects.
To run the unit tests, start sbt, and run test:
$ sbt
> test
To run the scripted tests, start sbt and run scripted:
$ sbt
> scripted
Individual scripted tests can be run like
$ sbt
> scripted sbt-version-policy/simple
Note that sbt is able to auto-complete the test names. See the completions by entering Tab.
Whenever it makes sense, add unit tests and / or scripted tests when adding new features or fixing existing ones.