From f65cc6bac6a64bf3b8880cf5d67c28ccb166be45 Mon Sep 17 00:00:00 2001 From: tastytea Date: Mon, 23 Sep 2019 19:27:26 +0200 Subject: [PATCH 1/4] =?UTF-8?q?Add=20=E2=80=9Cpatch=20via=20email=E2=80=9D?= =?UTF-8?q?-paragraph=20to=20contributing=20guidelines.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .editorconfig | 1 + CONTRIBUTING.adoc | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/.editorconfig b/.editorconfig index 1100de0..66c443a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -6,6 +6,7 @@ root = true [*] indent_style = space indent_size = 4 +tab_width = 4 end_of_line = lf charset = utf-8 trim_trailing_whitespace = true diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index c751b79..e23e308 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -1,4 +1,5 @@ :project: mastodon-cpp +:patch_contact: tastytea@tastytea.de == How to contribute @@ -20,3 +21,6 @@ account. 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 email, to {patch_contact} (ideally using +`git format-patch` or `git send-email`). From 7857b17b8be192d76009744c09528096d286fbd1 Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 27 Sep 2019 03:52:22 +0200 Subject: [PATCH 2/4] Fix contact-variable in COC. --- CODE_OF_CONDUCT.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc index 227e1d2..a561593 100644 --- a/CODE_OF_CONDUCT.adoc +++ b/CODE_OF_CONDUCT.adoc @@ -1,4 +1,4 @@ -:coc_contact: tastytea@tastytea.de +:contact-coc: tastytea@tastytea.de == Code of Conduct @@ -32,7 +32,7 @@ Examples of unacceptable behavior by participants include: === Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at {coc_contact}. +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 From ff846a63cb93c0d11f40321bd9a3ed84b6465326 Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 27 Sep 2019 03:52:38 +0200 Subject: [PATCH 3/4] Make more use of variables in contribution guidelines. --- CONTRIBUTING.adoc | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index e23e308..64170ac 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -1,9 +1,13 @@ :project: mastodon-cpp -:patch_contact: tastytea@tastytea.de +:uri-base: https://schlomp.space/tastytea/{project} +:uri-coc: {uri-base}/src/branch/master/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:CODE_OF_CONDUCT.adoc[Code of Conduct]. +Read the link:{uri-coc}[Code of Conduct]. === Reporting bugs or suggesting enhancements @@ -12,15 +16,14 @@ 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:tastytea@tastytea.de[E-Mail], -link:xmpp:tastytea@tastytea.de[XMPP] or the -https://likeable.space/users/tastytea[Fediverse] if you don't want to open an -account. +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 email, to {patch_contact} (ideally using -`git format-patch` or `git send-email`). +You can also send me your patches via mailto:{contact-email}[E-Mail], ideally +using `git format-patch` or `git send-email`. From 28919cdaa882ce9f76c93ba1c189ff3152750577 Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 27 Sep 2019 03:52:58 +0200 Subject: [PATCH 4/4] Include contribution guidelines in readme. --- README.adoc | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.adoc b/README.adoc index 4e21994..b1c70ff 100644 --- a/README.adoc +++ b/README.adoc @@ -1,6 +1,8 @@ = mastodon-cpp :toc: preamble :project: mastodon-cpp +:uri-base: https://schlomp.space/tastytea/{project} +:uri-branch-main: {uri-base}/src/branch/master *{project}* is a C++ wrapper for the Mastodon API. You submit an API call and get the raw JSON or easy to use abstractions. @@ -10,9 +12,7 @@ and get the raw JSON or easy to use abstractions. The HTML reference can be generated with `build_doc.sh`, if doxygen is installed. It is also available at https://doc.schlomp.space/{project}/annotated.html[doc.schlomp.space/{project}/]. -There are more -https://schlomp.space/tastytea/{project}/src/branch/master/examples[examples] -in `examples/`. +There are more {uri-branch-main}/examples[examples] in `examples/`. === Examples @@ -257,10 +257,7 @@ the filter ID with `MASTODON_CPP_FILTER_ID`. You can select the list ID with * Have at least 1 list with at least one account in it. * have at least 1 account muted. -== Contributing - -See -https://schlomp.space/tastytea/{project}/src/branch/master/CONTRIBUTING.adoc[CONTRIBUTING.adoc]. +include::{uri-base}/raw/branch/master/CONTRIBUTING.adoc[] == Status of implementation