Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
45 lines (33 loc) · 1.48 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

45 lines (33 loc) · 1.48 KB
Raw

Summary

Describe the problem, the change, and the reader or maintainer outcome.

Change type

  • Catalog resource or classification
  • Bilingual editorial content
  • Catalog export or consumer contract
  • Tests, tooling, or workflow
  • Governance or documentation

Evidence and scope

  • Related issue:
  • Source or maintenance evidence:
  • Website consumer impact:
  • Intentionally out of scope:

For catalog changes, explain the official source, review date, license or ownership, maintenance state, API-key or payment requirements, and safety risk. Disclose any affiliation or self-promotion.

Validation

List the actual results, not only the commands you intended to run.

  • python -m pytest
  • python tools/validate_catalog.py
  • python tools/export_catalog.py --check
  • python tools/render_readmes.py --check
  • python tools/build_content_manifest.py --check
  • python tools/verify_examples.py
  • English and Chinese output remain consistent
  • No secrets, generated reports, local build output, or analytics IDs were committed

Catalog links are fetched only by the scheduled or manually dispatched workflow, not by pull-request CI.

Permissions and review

  • I have the right to submit this contribution.
  • I retained third-party notices and did not relicense third-party material.
  • Human reviewers wrote or verified all resource descriptions and classifications.
  • I read CONTRIBUTING.md and docs/CURATION_POLICY.md.