From 9dea3e9051dd4c07289c2a16cba742089ad5520b Mon Sep 17 00:00:00 2001 From: jvoisin Date: Sun, 7 Apr 2019 10:55:51 +0200 Subject: [PATCH] Add a CONTRIBUTING.md file --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..bc39eec5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Getting a .war + +Airsonic is using [Maven](https://maven.apache.org/) to manage its build +process. Any version above 3.3+ should do the job. + +If you want to run the testsuite and get a `.war` is everything went fine, +you this command: + +``` +$ mvn clean package +``` + +If you don't care about the result of the testsuite, but only +want a `.war` as quick as possible, you can use this instead: + +``` +$ mvn -Dmaven.test.skip=true clean package +``` + +# Suggesting modifications + +Airsonic's source code is hosted on [github](https://github.com/airsonic/airsonic/), +who provides a [lot of documentation](https://help.github.com/en) on how +to contribute to projects hosted there. + +# Getting help + +The documentation is hosted [here](https://airsonic.github.io/) (you can +contribute to it [here](https://github.com/airsonic/documentation)), and aims +at being comprehensive. You can also use [irc](irc://irc.freenode.net/airsonic) +and [reddit](https://www.reddit.com/r/airsonic/) if you want to discuss or ask +questions.