jlengrand/jreleaser.github.io
1
0
Fork 0
mirror of https://github.com/jlengrand/jreleaser.github.io.git synced 2026-03-10 08:31:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add contributing doc

Browse Source
This commit is contained in:
Andres Almiray
2021-05-28 00:01:30 +02:00
parent 89894c6a34
commit ef37f01f91
1 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
CONTRIBUTING.adoc Normal file
View File

@@ -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