Skip to content

docs: add English contributing documentation and matcher template#235

Merged
MapoMagpie merged 1 commit into
MapoMagpie:masterfrom
jicetus:docs/contributing-english
Jul 16, 2026
Merged

docs: add English contributing documentation and matcher template#235
MapoMagpie merged 1 commit into
MapoMagpie:masterfrom
jicetus:docs/contributing-english

Conversation

@jicetus

@jicetus jicetus commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Add a full contributing guide (in English) and supporting docs:

  • Add CONTRIBUTING.md top-level contributing guide
    • Covers quick start, repo overview, adding site support, fixing bugs, and debugging workflows
  • In .assets/
    1. Add CONTRIBUTING_ARCHITECTURE.md explaining matcher lifecycle, page/image fetching pipeline, and key module interactions
    2. Add PROJECT_STRUCTURE.md complete project structure with full directory tree and component explanations
  • Add template-example.ts at src/platform/matchers/ to simplify adding new site adapters
  • Renamed existing .assets/CONTRIBUTING.mdCONTRIBUTING_CN.md for clarity
  • Update README.md to include new contributing section with files referenced

Add a full CONTRIBUTING guide and supporting docs: .assets/CONTRIBUTING_ARCHITECTURE.md and .assets/PROJECT_STRUCTURE.md. Rename existing .assets/CONTRIBUTING.md to .assets/CONTRIBUTING_CN.md (localized). Add a top-level CONTRIBUTING.md and update README.md to reference contributing resources. Include a new matcher template starter: src/platform/matchers/template-example.ts to simplify adding new site adapters.
@MapoMagpie

Copy link
Copy Markdown
Owner

Thank you.

@MapoMagpie
MapoMagpie merged commit ad49506 into MapoMagpie:master Jul 16, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants