mirror of
https://github.com/wesammustafa/opencode-primer.git
synced 2026-11-19 02:17:58 +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).
31 lines
974 B
Markdown
31 lines
974 B
Markdown
## What this changes
|
|
|
|
<!-- 1-3 sentences. What and why. -->
|
|
|
|
## Type
|
|
|
|
- [ ] Fact correction (something here is out of date or wrong)
|
|
- [ ] New content (doc, MCP walkthrough, specialized-agent prompt, etc.)
|
|
- [ ] Restructure / cleanup
|
|
- [ ] Typo / formatting / lint fix
|
|
|
|
## Sources
|
|
|
|
<!--
|
|
For factual changes, link to the primary source you used:
|
|
- opencode.ai/docs/...
|
|
- github.com/anomalyco/opencode/...
|
|
- A specific release note or commit
|
|
|
|
Drive-by claims without sources will get held until they can be verified.
|
|
-->
|
|
|
|
## Checklist
|
|
|
|
- [ ] I read [`CONTRIBUTING.md`](../CONTRIBUTING.md)
|
|
- [ ] Every factual claim cites a source (in the PR or inline in the doc)
|
|
- [ ] In-page anchors and cross-doc links still resolve
|
|
- [ ] No trailing whitespace; code fences have language tags
|
|
- [ ] Emoji follow the [`AGENTS.md` policy](../AGENTS.md#style-conventions) (H2 navigation + callout prefixes only)
|
|
- [ ] If I touched the README, I updated the "Last reviewed" line at the bottom
|