Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.71 KB

Contributing to missinglink

First of all, thanks for the interest in missinglink! 👏

As mentioned in the README, this project is very young and not mature yet.

It was built during a Hack Week at Spotify to attempt to catch a certain type of dependency conflict with Maven projects that the authors had bad experiences with.

Submitting issues

We'd like for it to be able to catch lots of other types of conflicts but there are a lot of scenarios we have not encountered or will be able to test, so any and all feedback is appreciated.

To report any issues or share feedback you have, please create an issue on Github. We'd like to hear about false positives that this tool reports for you, or conflicts that it seems like should be caught but weren't.

Building the project

With Java 8+ and Maven 3+, simply run mvn install in the project directory.

For any patches, please make sure that they pass all tests (and that new tests are added).

Code will be automatically formatted by https://github.com/coveooss/fmt-maven-plugin when you run mvn compile. The CI build will fail if any code is not formatted according to the plugin's rules.

New code should be accompanied by tests that increase the overall code coverage of the project.

Additional documentation