mirror of
https://github.com/wesammustafa/opencode-primer.git
synced 2026-11-18 18:04:22 +00:00
Community and contributor support:
- CONTRIBUTING.md: what we welcome, what we don't, style guide,
templates for MCP walkthroughs and specialized-agent prompts.
- CODE_OF_CONDUCT.md: Contributor Covenant 2.1.
- SECURITY.md: scope (this is a docs repo, not application code), how
to report a vulnerability in the example plugins or in misleading
documentation, where OpenCode-core bugs should go instead.
GitHub plumbing:
- .github/PULL_REQUEST_TEMPLATE.md: type, sources, hygiene checklist.
- .github/ISSUE_TEMPLATE/{bug_report,feature_request}.md and config.yml
that redirects OpenCode-tool issues to the right place.
- .github/workflows/lint-docs.yml: three jobs on every push and PR —
markdownlint, link check (with sensible ignore patterns for
../../issues, security advisories, localhost), codespell with a
project-specific ignore list.
Lint/style configs:
- .markdownlint.json + .markdownlintignore: ATX headings, ordered list
numbering, line-length and inline-HTML rules tuned for our content.
- .editorconfig: LF, UTF-8, 2-space indent, trim trailing whitespace
except in markdown (where trailing spaces are line breaks).
40 lines
2.1 KiB
Markdown
40 lines
2.1 KiB
Markdown
# Code of Conduct
|
|
|
|
## Our pledge
|
|
|
|
We — maintainers and contributors — pledge to make participation in this project a harassment-free experience for everyone, regardless of age, body size, 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 commit to acting 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, apologizing to those affected by mistakes, and learning from the experience
|
|
- Focusing on what is best for the overall community
|
|
|
|
**Examples of unacceptable behavior:**
|
|
|
|
- The use of sexualized language or imagery, and unwelcome sexual attention or advances
|
|
- Trolling, insulting or derogatory comments, and personal or political attacks
|
|
- Public or private harassment
|
|
- Publishing others' private information (physical or email address) without explicit permission
|
|
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
|
|
|
## Scope
|
|
|
|
This Code of Conduct applies within all project spaces — issues, pull requests, discussions, commit comments, and any community channels associated with the project — and also applies when an individual is officially representing the project in public spaces.
|
|
|
|
## Enforcement
|
|
|
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the maintainers by opening a confidential issue or contacting the repository owner directly. All complaints will be reviewed and investigated promptly and fairly.
|
|
|
|
Maintainers are obligated to respect the privacy and security of the reporter of any incident.
|
|
|
|
## Attribution
|
|
|
|
This Code of Conduct is adapted from the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
|