mirror of
https://github.com/jlengrand/jreleaser.github.io.git
synced 2026-03-10 08:31:25 +00:00
28 lines
816 B
Plaintext
28 lines
816 B
Plaintext
= 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
|