Adding CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# How to Contribute
+
+[Fork](https://help.github.com/articles/fork-a-repo) FunctionalUtils, send a [pull request](https://help.github.com/articles/using-pull-requests) and keep your fork in [sync](https://help.github.com/articles/syncing-a-fork/) with the upstream repository.
+
+FunctionalUtils has no dependencies other than Java 21.
+
+Other forms of contributing highly appreciated:
+1. Creating an issue for a bug you found or a feature you would like to see.
+2. Writing documentation or enhancing existing documentation.
+3. Writing tests.
+4. Spreading the word about FunctionalUtils in a blog article, or a LinkedIn post or twitter or anything else.
+
+## Building
+
+`mvn clean install` builds the project and runs all tests.
+
+`mvn clean install -DskipTests` builds the project without running tests.

README.md

@@ -12,6 +12,8 @@ It is also inspired by libraries such as `Vavr` or `Cyclops`. But these have iss
 2. They are not zero-dependencies libraries.
 3. They have a big learning curve.
 
+It is a small library, and it will never compete the big ones, but it can be useful for those that would like to remain lean.
+
 ## Features
 
 1. `Either` monad which represents a value that can be either of two types.