From ef37f01f91915a737b75fba19395a6d53fe4f80e Mon Sep 17 00:00:00 2001 From: Andres Almiray Date: Fri, 28 May 2021 00:01:30 +0200 Subject: [PATCH] Add contributing doc --- CONTRIBUTING.adoc | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 CONTRIBUTING.adoc diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 0000000..6050506 --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,27 @@ += Contributing + +Anyone is welcome to open link:https://github.com/jreleaser/jreleaser.github.io/issues[issues] and/or pull-requests for +documentation fixes and updates. + +== Code of Conduct + +This project and everyone participating in it is governed by our link:CODE_OF_CONDUCT.md[Code of Conduct]. +By participating, you are expected to uphold this code. Please report unacceptable behavior to jreleaser@kordapm.org. + +== How to build + +* Install link:https://antora.org/[Antora]. + +* Generate the site +[source,sh] +---- +$ antora local-playbook.yml +---- + +* Browse to `build/site/index.html`. + +=== Git Commit Messages + + * Use the present tense ("Add feature" not "Added feature") + * Use the imperative mood ("Move cursor to..." not "Moves cursor to...") + * Reference issues and pull requests liberally after the first line