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).
55 lines
1.3 KiB
YAML
55 lines
1.3 KiB
YAML
name: Lint docs
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
markdownlint:
|
|
name: markdownlint
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
|
|
- name: Run markdownlint-cli2
|
|
uses: DavidAnson/markdownlint-cli2-action@v20
|
|
with:
|
|
globs: |
|
|
**/*.md
|
|
!node_modules
|
|
|
|
link-check:
|
|
name: Link check
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
|
|
- name: Markdown link check
|
|
uses: gaurav-nelson/github-action-markdown-link-check@v1
|
|
with:
|
|
use-quiet-mode: "yes"
|
|
use-verbose-mode: "yes"
|
|
config-file: ".github/markdown-link-check.json"
|
|
# Only changed files on PR; everything on push
|
|
check-modified-files-only: ${{ github.event_name == 'pull_request' && 'yes' || 'no' }}
|
|
base-branch: main
|
|
|
|
spellcheck:
|
|
name: Spell check
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
|
|
- name: codespell
|
|
uses: codespell-project/actions-codespell@v2
|
|
with:
|
|
# Tune by adding words to .github/codespell-ignore.txt
|
|
ignore_words_file: .github/codespell-ignore.txt
|
|
# Skip files we don't author
|
|
skip: ./LICENSE,./.git,./node_modules
|