This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/develop by this push:
new 13d6466732 chore(site/contributing): add note for conventional commits
on contributing site
13d6466732 is described below
commit 13d6466732b67af9b8a7bc70fa87e5ccd3758788
Author: Sebastian Rühl <[email protected]>
AuthorDate: Fri Oct 20 09:59:07 2023 +0200
chore(site/contributing): add note for conventional commits on contributing
site
---
src/site/asciidoc/developers/contributing.adoc | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/src/site/asciidoc/developers/contributing.adoc
b/src/site/asciidoc/developers/contributing.adoc
index ad016d2e24..09fc6a60cf 100644
--- a/src/site/asciidoc/developers/contributing.adoc
+++ b/src/site/asciidoc/developers/contributing.adoc
@@ -32,6 +32,12 @@ These usually are, but are not limited to:
We are a very friendly bunch and don't be afraid to step forward.
+=== Commits
+
+We make use of https://www.conventionalcommits.org/en/v1.0.0/[conventional
commits].
+As plc4x is a monolithic polyglot repository we usually define the scope as
`...(plc4[language shortcut here]/subcomponent)`
+(e.g. a new feature in Bacnet in the Golang part would have a message of
`feat(plc4go/bacnet): cool new feature for...`).
+
=== Pull-Requests
The simplest way to submit code changes, is via a GitHub pull-request.
