summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortastytea2020-01-03 06:29:54 +0100
committertastytea2020-01-03 06:30:29 +0100
commit4d7d360f9465ce88f31e3773cb6a4bfc5ed1fb18 (patch)
treec3f1c9efb66aeb499fb8ead3a0291589d7fac322
parent53bd5503c87920aac0e6e7e7eeb8a42978ff40d6 (diff)
downloadmastodonpp-4d7d360f9465ce88f31e3773cb6a4bfc5ed1fb18.tar
mastodonpp-4d7d360f9465ce88f31e3773cb6a4bfc5ed1fb18.tar.gz
mastodonpp-4d7d360f9465ce88f31e3773cb6a4bfc5ed1fb18.zip
Add contributing guidelines and COC.
-rw-r--r--CODE_OF_CONDUCT.adoc50
-rw-r--r--CONTRIBUTING.adoc29
-rw-r--r--README.adoc2
3 files changed, 81 insertions, 0 deletions
diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc
new file mode 100644
index 0000000..86b6f15
--- /dev/null
+++ b/CODE_OF_CONDUCT.adoc
@@ -0,0 +1,50 @@
+:contact-coc: tastytea@tastytea.de
+:uri-coc-original: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+== Code of Conduct
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, education, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, sex
+characteristics, sexual identity and orientation or socio-economic status.
+
+=== Examples
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language.
+* Being respectful of differing viewpoints and experiences.
+* Gracefully accepting constructive criticism.
+* Focusing on what is best for the community.
+* Showing empathy towards other community members.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances.
+* Trolling, insulting/derogatory comments, and personal attacks.
+* Public or private harassment.
+* Publishing others’ private information, such as a physical or electronic
+ address, without explicit permission.
+
+=== Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at {contact-coc}.
+
+All complaints will be reviewed and investigated and will result in a response
+that is deemed necessary and appropriate to the circumstances. The project team
+is obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+=== Attribution
+
+This Code of Conduct is adapted from the link:{uri-coc-original}[Contributor
+Covenant, version 1.4].
+
+
+For answers to common questions about this code of conduct, see
+link:https://www.contributor-covenant.org/faq[].
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`.
diff --git a/README.adoc b/README.adoc
index 4842e1c..d9dbafc 100644
--- a/README.adoc
+++ b/README.adoc
@@ -7,3 +7,5 @@
*{project}* is a C++ wrapper for the Mastodon API. It replaces
link:{uri-mastodon-cpp}[mastodon-cpp].
+
+include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]