commit 165deb1e4dd4ca4508f856caee3e3f6fedbc84a5
parent f26e001e1d29999f9b8d234668c13a4033cd9224
Author: Johann150 <johann.galle@protonmail.com>
Date: Wed, 10 Feb 2021 08:06:03 +0100
add community documents
Diffstat:
| A | CODE_OF_CONDUCT.md | | | 85 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | CONTRIBUTING.md | | | 92 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 177 insertions(+), 0 deletions(-)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,85 @@
+
+# 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, 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 a maintainer listed in the `Cargo.toml` file via email.
+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.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+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.0]: https://www.contributor-covenant.org/version/2/0/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
@@ -0,0 +1,92 @@
+# Contributing
+
+## Contents
+
+- [Introduction](#introduction)
+- [Code of Conduct](#code-of-conduct)
+- [Reporting Bugs and Suggesting Improvements](#reporting-bugs-and-suggesting-improvements)
+- [Contribution Workflow](#contribution-workflow)
+- [Quality Standards](#quality-standards)
+- [Release Process](#release-process)
+
+## Introduction
+
+Hello, and welcome to the contributing guide for Agate!
+
+Agate is mostly maintained in the spare time of contributors, so be patient if it takes a bit longer to respond.
+By following this guide you'll make it easier for us to address your issues or incorporate your contributions.
+
+We look forward to working with you!
+
+## Code of Conduct
+
+Please note that this project is released with a [Code of Conduct](./CODE_OF_CONDUCT.md).
+By participating in this project you agree to abide by its terms.
+
+## Reporting Bugs and Suggesting Improvements
+
+Bugs (unwanted behaviour) and suggested improvements are tracked as [GitHub issues][github-issues].
+Before reporting an issue, please check the following points:
+
+1. The issue is caused by Agate itself and not by how it is used.
+ Have a look at the documentation if you are not sure.
+ If you cannot connect to Agate via the Internet, please try connecting with a client on the same machine to make sure the problem is not caused by intermediate infrastructure.
+1. Your issue has not already been reported by someone else.
+ Please look through the open issues in the [issue tracker][github-issues].
+
+When reporting an issue, please add as much relevant information as possible.
+This will help developers and maintainers to resolve your issue. Some things you might consider:
+
+* Use a descriptive title.
+* State which version you are using (use a version tag like `v2.4.1` or the commit hash).
+* If you are using tools provided with agate (like a startup script), please also state that.
+* Describe how the problem can be reproduced.
+* Explain what exactly is the problem and what you expect instead.
+
+[github-issues]: https://github.com/brendanzab/codespan/issues
+
+## Contribution Workflow
+
+Follow these steps to contribute to the project:
+
+1. Make a fork of the [Agate repository][agate-repo].
+1. Within your fork, create a branch for your contribution. Use a meaningful name.
+1. Create your contribution, meeting all [contribution quality standards](#quality-standards).
+1. [Create a pull request][create-a-pr] against the `master` branch of the repository.
+1. Once the pull request is reviewed and CI passes, it will be merged.
+
+[agate-repo]: https://github.com/mbrubeck/agate
+[create-a-pr]: https://help.github.com/articles/creating-a-pull-request-from-a-fork/
+
+## Quality Standards
+
+Most quality and style standards are checked automatically by the CI build.
+Contributions should:
+
+- Separate each **logical change** into its own commit.
+- Update the changelog with any added, removed, changed, or fixed functionality. Adhere to the changelog format.
+- Ensure the code compiles correctly, if you can also run `cargo clippy`.
+- Format code with `cargo fmt`.
+- Avoid adding `unsafe` code.
+ If it is necessary, provide an explanatory comment on any `unsafe` block explaining its rationale and why it's safe.
+- Add a descriptive message for each commit.
+ Follow [these commit message guidelines][commit-messages].
+- Document your pull requests.
+ Include the reasoning behind each change, and the testing done.
+
+[commit-messages]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+## Release Process
+(This is only relevant if you are a maintainer.)
+
+1. Bump the version number appropriately. (Update `Cargo.lock` too!)
+1. Run `cargo package` to make sure everything compiles correctly.
+1. Update the changelog with the new version ranges.
+1. Add a git tag for the version, e.g. with `git tag v2.4.1`.
+1. Push the changelog commit and tag to the repository.
+ Upon detecting the push of a tag beginning with "v", CI should start building the prebuilt binaries.
+ These binaries will be uploaded to a new draft GitHub release with the same name as the version tag. (You need push access to see it).
+1. Run `cargo publish` to publish to [crates.io](https://crates.io/crates/agate).
+1. Fill the GitHub release text with the appropriate entries from the changelog.
+1. Wait for the binary compilation to finish.
+1. Publish the GitHub release.
