A fuzzy matching string distance library for Scala and Java that includes Levenshtein distance, Jaro distance, Jaro-Winkler distance, Dice coefficient, N-Gram similarity, Cosine similarity, Jaccard similarity, Longest common subsequence, Hamming distance, and more..
Alternatively, could include the sbt-launch.jar file in the project, and the only dependency would be having Java 8. (https://github.com/sbt/launcher)
Need to include instructions about forking/branching from latest snapshot branch and opening PR's against the snapshot branch (currently, 1.0.8-SNAPSHOT is the branch)
Instructions on how to run unit tests (sbt test runs unit tests) and the ./test.sh command will run the linter (scalastyle), unit tests, generate a coverage report, and check that code coverage is adequate (100%).
Instructions on how to generate and check documentation (sbt doc will create the documentation in your local /target folder of the project)
Need to add a
CONTRIBUTING.md
file that outlines:Alternatively, could include the
sbt-launch.jar
file in the project, and the only dependency would be having Java 8. (https://github.com/sbt/launcher)Need to include instructions about forking/branching from latest snapshot branch and opening PR's against the snapshot branch (currently,
1.0.8-SNAPSHOT
is the branch)Instructions on how to run unit tests (
sbt test
runs unit tests) and the./test.sh
command will run the linter (scalastyle), unit tests, generate a coverage report, and check that code coverage is adequate (100%).Instructions on how to generate and check documentation (
sbt doc
will create the documentation in your local/target
folder of the project)Code style and conventions - Could use https://github.com/excellalabs/intro-to-functional-scala/blob/master/scala-style-guide.md or https://github.com/databricks/scala-style-guide
PR etiquette and general guidelines