Add CONTRIBUTING.md

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 email 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 [kiko@barcelli.net](mailto:kiko@barcelli.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

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing to revelupex
+
+First of all, thanks a lot for taking the time to contribute!
+
+All types of contribuions are encouraged and appreciated.
+
+> And if you like the project, but just don't have time to contribute, that's pefectly fine. There are many other ways to support the project and show your appreciation, which we would be very happy about:
+> 
+> * Star the project.
+> * Shout out about it in social media.
+> * Mention the project to your friends and colleagues.
+> * Refer this project in your own projects.
+
+## I Have a Question
+
+Before asking a question, please search for existing [Issues](https://gitea.barcelli.net/kikobar/revelupex/issues) that might help you. In case you found a suitable issue but still need clarification, you can write your question in this issue.
+
+If you still need to ask a question we recommend:
+
+* Open and [Issue](https://gitea.barcelli.net/kikobar/revelupex/issues/new).
+* Provide as much context and information as you can about the issue/question you are facing.
+
+We will take care of the issue as soon as possible.
+
+## Reporting Bugs
+
+Bugs and errors are tracked as issues.
+
+* Open an [Issue](https://gitea.barcelli.net/kikobar/revelupex/issues/new).
+* A good bug report should be able to describe the issue and allow others to reproduce it in their own systems, so please provide details about:
+  * The specific OS, platform and version you are using.
+  * The steps to reproduce the issue.
+  * The behavior you are expecting.
+  * The problematic behaviour you are observing.
+  * Include examples, screenshots, logs and whatever else you think it could be helpful.
+
+We will take care of your report as soon as possible.
+
+> Please note that you must never report security related issues, vulnerabilities or bugs including sensitive informetion through the issue tracker, or elsewhere in public. Sensitive bugs must be sent by encrypted email to <kiko@barcelli.net> using the following PGP key: [0x70c7d0901133471df2e6e9a8006c13a68e25d3b7](https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x70c7d0901133471df2e6e9a8006c13a68e25d3b7)
+
+## Suggesting Enhancements
+
+Suggestions and enhancements are discussed and managed as issues.
+
+* Make sure you are using the latest version.
+* Search and read carefully for existing discussions about similar suggestions in the [Issues](https://gitea.barcelli.net/kikobar/revelupex/issues). You may consider adding your comments or suggestion to an existing issue.
+* If you consider that your suggestion will be better represented as a new entry:
+  * Open an [Issue](https://gitea.barcelli.net/kikobar/revelupex/issues/new).
+  * Use a **clear and descriptive title** for the issue to identify the suggestion.
+  * Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+  * **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+  * You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to.
+  * **Explain why this enhancement would be useful** to most users of the project. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+We will consider your suggestion as soon as possible.
+
+## I Want To Contribute Content
+
+> ### Legal Notice
+> 
+> When contributing content to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+To contribute content to this project:
+
+* Clone or fork the repo, and make your suggested contributions.
+* Publish your contributions to any publicly available Git server.
+* Send a git-request-pull to <kiko@barcelli.net> for consideration.
+
+We will consider your git-request-pull as soon as possible.
+
+## Login Credentials
+
+In order to contribute to this project in any of the ways described above, you will need login credentials to the server where this repository is hosted.
+
+You may contact the administrator at <info@barcelli.net> to request for an account to be created for you.