Add contributing guidelines, a COC and EditorConfig.

This commit is contained in:
tastytea 2019-09-22 03:38:14 +02:00
parent ff43aea4ab
commit 66d41fec46
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
5 changed files with 90 additions and 16 deletions

13
.editorconfig Normal file
View File

@ -0,0 +1,13 @@
# Configuration file for EditorConfig.
# More information is available under <https://editorconfig.org/>.
root = true
[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = 80

49
CODE_OF_CONDUCT.adoc Normal file
View File

@ -0,0 +1,49 @@
:coc_contact: tastytea@tastytea.de
== 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 {coc_contact}.
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 Contributor Covenant, version 1.4,
available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

22
CONTRIBUTING.adoc Normal file
View File

@ -0,0 +1,22 @@
:project: mastodon-cpp
== How to contribute
Read the link:CODE_OF_CONDUCT.adoc[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: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.
=== 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.

View File

@ -1,16 +0,0 @@
# How to contribute
## Reporting bugs or suggesting enhancements
Before reporting a bug , please
[perform a search](https://schlomp.space/tastytea/mastodon-cpp/issues)
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 the Fediverse if you don't want to open an account.
My account is [@tastytea@likeable.space](https://likeable.space/users/tastytea).
## 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.

View File

@ -1,5 +1,6 @@
= mastodon-cpp
:toc: preamble
:project: mastodon-cpp
*mastodon-cpp* is a C++ wrapper for the Mastodon API. You submit an API call
and get the raw JSON or easy to use abstractions.
@ -256,6 +257,11 @@ 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/main/CONTRIBUTING.adoc[CONTRIBUTING.adoc].
== Status of implementation
You can still use unsupported calls by using `API::get` and the others with