From 4463998fe79e86be93a4a1f99e5de85f6ad7939e Mon Sep 17 00:00:00 2001 From: Yury Pikhtarev Date: Tue, 1 Jul 2025 01:05:59 +0400 Subject: [PATCH] feat: add contributing guidelines and enhance documentation clarity - Introduced a new contributing.md file outlining the Contributor Covenant Code of Conduct, community standards, enforcement responsibilities, and guidelines. - Updated setup.md and installation.md to remove links from next steps, improving readability and accessibility. These changes establish clear community expectations and enhance the overall documentation structure for contributors. --- docs/docs/contributing.md | 131 ++++++++++++++++++++++ docs/docs/development/setup.md | 6 +- docs/docs/getting-started/installation.md | 6 +- 3 files changed, 137 insertions(+), 6 deletions(-) create mode 100644 docs/docs/contributing.md diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md new file mode 100644 index 000000000..b40ff39c8 --- /dev/null +++ b/docs/docs/contributing.md @@ -0,0 +1,131 @@ +--- +sidebar_position: 2 +title: Contributing +--- + +# 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 admin@torrentpier.com. +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](https://www.contributor-covenant.org/), version 2.1, +available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct/](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion). + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq/](https://www.contributor-covenant.org/faq/). Translations are available at +[https://www.contributor-covenant.org/translations/](https://www.contributor-covenant.org/translations/). diff --git a/docs/docs/development/setup.md b/docs/docs/development/setup.md index 7478e12b4..18e925a81 100644 --- a/docs/docs/development/setup.md +++ b/docs/docs/development/setup.md @@ -286,6 +286,6 @@ Follow conventional commits: ## Next Steps -- Review [Coding Standards](/docs/development/coding-standards) -- Learn about [Testing](/docs/development/testing) -- Understand [API Development](/docs/api/overview) +- Review Coding Standards +- Learn about Testing +- Understand API Development diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md index cb7903e8b..3fa65ad33 100644 --- a/docs/docs/getting-started/installation.md +++ b/docs/docs/getting-started/installation.md @@ -193,6 +193,6 @@ php artisan optimize:clear ## Next Steps -- Configure [Application Settings](/docs/getting-started/configuration) -- Set up [Email Configuration](/docs/getting-started/email) -- Review [Security Best Practices](/docs/getting-started/security) +- Configure Application Settings +- Set up Email Configuration +- Review Security Best Practices