mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-04-10 13:02:59 +00:00
Tier 1 organizational files that any open-source project at LEDMatrix's maturity is expected to have. None of these existed before. They're additive — no existing content was rewritten. CODE_OF_CONDUCT.md - Contributor Covenant 2.1 (the de facto standard for open-source projects). Mentions both the Discord and the GitHub Security Advisories channel for reporting violations. SECURITY.md - Private vulnerability disclosure flow with two channels: GitHub Security Advisories (preferred) and Discord DM. - Documents the project's known security model as intentional rather than vulnerabilities: no web UI auth, plugins run unsandboxed, display service runs as root for GPIO access, config_secrets.json is plaintext. These match the limitations already called out in PLUGIN_QUICK_REFERENCE.md and the audit flagging from earlier in this PR. - Out-of-scope section points users at upstream (rpi-rgb-led-matrix, third-party plugins) so reports land in the right place. .github/PULL_REQUEST_TEMPLATE.md - 10-line checklist that prompts for the things that would have caught the bugs in this very PR: did you load the changed plugin once, did you update docs alongside code, are there any plugin compatibility implications. - Linked from CONTRIBUTING.md for the full flow. README.md - Added a License section near the bottom (the README previously said nothing about the license despite the project being GPL-3.0). - Added a Contributing section pointing at CONTRIBUTING.md and SECURITY.md. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
138 lines
5.6 KiB
Markdown
138 lines
5.6 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, 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.
|
|
|
|
This includes the LEDMatrix Discord server, GitHub repositories owned by
|
|
ChuckBuilds, and any other forums hosted by or affiliated with the project.
|
|
|
|
## Enforcement
|
|
|
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
reported to the community leaders responsible for enforcement on the
|
|
[LEDMatrix Discord](https://discord.gg/uW36dVAtcT) (DM a moderator or
|
|
ChuckBuilds directly) or by opening a private GitHub Security Advisory if
|
|
the issue involves account safety. 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
|