summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.adoc')
-rw-r--r--CONTRIBUTING.adoc29
1 files changed, 29 insertions, 0 deletions
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc
new file mode 100644
index 0000000..eab82a8
--- /dev/null
+++ b/CONTRIBUTING.adoc
@@ -0,0 +1,29 @@
+:project: mastodonpp
+:uri-base: https://schlomp.space/tastytea/{project}
+:uri-coc: {uri-base}/src/branch/main/CODE_OF_CONDUCT.adoc
+:contact-email: tastytea@tastytea.de
+:contact-xmpp: {contact-email}
+:contact-fediverse: https://likeable.space/users/tastytea
+
+== How to contribute
+
+Read the link:{uri-coc}[Code of Conduct].
+
+=== Reporting bugs or suggesting enhancements
+
+Before reporting a bug, please
+https://schlomp.space/tastytea/{project}/issues[perform a search] to see if the
+problem has already been reported. If it has, add a comment to the existing
+issue instead of opening a new one. Same for enhancements.
+
+You can also contact me via mailto:{contact-email}[E-Mail],
+link:xmpp:{contact-xmpp}[XMPP] or the {contact-fediverse}[Fediverse] if you
+don't want to open an account.
+
+=== Pull requests
+
+Please use similar coding conventions as the rest of the project. The basic rule
+to remember is to write code in the same style as the existing/surrounding code.
+
+You can also send me your patches via mailto:{contact-email}[E-Mail], ideally
+using `git format-patch` or `git send-email`.