Jatin K MalikandGitHub
f48bdda525
* docs: polish project documentation for a clearer public surface Rewrite the README and supporting docs for a more professional first impression: less emoji and badge noise, install-first structure, and a real documentation index. Add a Contributor Covenant, tighten SECURITY and GitHub templates, and make distro/update guides read as product docs instead of internal status notes. * docs: split install guide and add changelog plus support pages Break INSTALL.md into a short primary guide, manual/PyPI package lists, and troubleshooting. Add root CHANGELOG.md and SUPPORT.md, wire them into the docs index and README, and drop the outdated screenshot lag note now that v0.15 assets are on main. * docs: humanize PR copy and remove em dashes Strip em/en dashes from the documentation rewritten in this PR, fix mid-sentence colon fallout from that pass, and smooth a few stiff phrases so the public docs read more natural. * docs: list Faster Whisper after rebase onto main Installer and CLI already accept faster_whisper. Document it next to the other engines, drop the outdated screenshot lag note, and keep the on-device wording honest for local vs remote.
128 lines
5.1 KiB
Markdown
128 lines
5.1 KiB
Markdown
# 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:
|
|
|
|
- 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:
|
|
|
|
- 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
|
|
jatinkrmalik@gmail.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.html.
|
|
|
|
Community Impact Guidelines were inspired by
|
|
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
|
|
|
For answers to common questions about this code of conduct, see the FAQ at
|
|
https://www.contributor-covenant.org/faq. Translations are available at
|
|
https://www.contributor-covenant.org/translations.
|