This repository has been archived on 2021-03-22. You can view files and clone it, but cannot push or open issues or pull requests.
backend/CONTRIBUTING.adoc

38 lines
1.4 KiB
Plaintext
Raw Normal View History

2020-06-29 03:01:30 +02:00
:project: fediblock-backend
2020-06-29 06:24:56 +02:00
:uri-base: https://schlomp.space/FediBlock/backend
2020-06-29 03:01:30 +02:00
:uri-branch-main: {uri-base}/src/branch/main
:uri-coc: {uri-branch-main}/CODE_OF_CONDUCT.adoc
:contact-email: tastytea@tastytea.de
:contact-xmpp: {contact-email}
:contact-fediverse: https://likeable.space/users/tastytea
:uri-git-format-patch: https://git-scm.com/docs/git-format-patch
:uri-git-send-email: https://git-scm.com/docs/git-send-email
== How to contribute
Read the link:{uri-coc}[Code of Conduct].
=== Reporting bugs or suggesting enhancements
Before reporting a bug, please
2020-06-29 06:24:56 +02:00
https://schlomp.space/FediBlock/backend/issues[perform a search] to see if the
2020-06-29 03:01:30 +02:00
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.
Add a copyright line with the year, your name and your email address to the
files you edited. Add your name and email to
link:{uri-branch-main}/AUTHORS[AUTHORS]. Unless you don't want to.
You can also send me your patches via mailto:{contact-email}[E-Mail], ideally
using link:{uri-git-send-email}[git send-email].