adding code of conduct and contribution file

Signed-off-by: Banana <mail@bananas-playground.net>

diff --git a/CHANGELOG b/CHANGELOG
index 745ff8909cc4132cdac7308c6e01daada7334f43..17facb220bc1467c0cce553292d839bd5f50e943 100644 (file)
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -6,6 +6,7 @@
 + Folder structure to separate crawler and web interface.
 + Setup sql file changed. Creation of the database needs to be done beforehand.
 + Updated documentation.
++ Added contribution and code of conduct information.
 
 0.2
 + Cleanups

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644 (file)
index 0000000..3a07ea9
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+mail -@- bananas-playground.net
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..d105482
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,41 @@
+# How to contribute to aranea
+
+This project does use the [master branch][masterbranch] as the currently released version.
+The [develop branch][developbranch] is the main branch for improvements and workplace for a future version.
+
+Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
+
+    $ git commit -m "A brief summary of the commit
+    >
+    > A paragraph describing what changed and its impact."
+
+## Did you find a bug?
+
+* Use the [master branch][masterbranch] as a base for your pull request.
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/bananas-repos/aranea/issues).
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/bananas-repos/aranea/issues/new). 
+* Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+## Did you write a patch that fixes a bug?
+
+* Use the [master branch][masterbranch] as a base for your pull request.
+* Open a new GitHub pull request with the patch.
+* Ensure the pull request description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+## Did you fix whitespace, format code, or make a purely cosmetic patch?
+
+Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability
+will generally not be accepted.
+
+## Do you intend to add a new feature or change an existing one?
+
+* **You need to use the [develop branch][developbranch] as a base to make a GitHub pull request about a feature or improvement.**
+* Open a GitHub pull request based on the [develop branch][developbranch] and include a **title and clear description** also as much relevant information as possible to clearly describe your intentions.
+* Any GitHub pull request will be reviewed carefully. Please be patient, sometimes it can take some time to respond.
+
+## Coding conventions
+
+Start reading the code and you'll get the hang of it. The code is optimized for readability.
+
+[masterbranch]: https://github.com/bananas-repos/aranea/tree/master
+[developbranch]: https://github.com/bananas-repos/aranea/tree/develop

diff --git a/README.md b/README.md
index 42d301bc055bee253872628aa11d3287bcc901ac..90faa5be49ec59be6ff6ac7790f62cead627f9a0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,3 +39,13 @@ A good idea is to run it with a DNS filter, which has a good blocklist.
 
 The folder `webroot` does contain a webinterface which displays the gathered data and status.
 It does not provide a way to execute the crawler.
+
+# Contribute
+
+Want to contribute or found a problem?
+
+See Contributing document: CONTRIBUTING.md
+
+# Uses
+
+See uses document: USES

diff --git a/USES b/USES
new file mode 100644 (file)
index 0000000..12b6d00
--- /dev/null
+++ b/USES
@@ -0,0 +1 @@
+https://getuikit.com/