Contributing

August 17, 2026 ยท View on GitHub

Thank you for improving this open-content project. Contributions should make a claim more accurate, a task more executable, a translation more faithful, or the site easier and safer to use.

Before Opening a Pull Request

  1. Use Node 24: nvm use or your preferred version manager.
  2. Install exactly from the lock file: npm ci.
  3. Create a focused branch and avoid unrelated formatting or media changes.
  4. Run npm run sync after changing navigation, the Chinese homepage, or a Chinese word list.
  5. Run npm run check, npm run docs:build, and npm run test:smoke.

Content Standard

  • Separate research findings, personal experience, and hypotheses.
  • For factual or product claims, prefer primary sources and include an access/update date.
  • State population, conditions, outcome, and uncertainty when summarising research.
  • Do not present medical, legal, financial, mental-health, or safety content as professional advice.
  • Every public Chinese page needs a complete English counterpart, and vice versa. Preserve meaning rather than translating word for word.
  • Add title, description, and updated: YYYY-MM-DD frontmatter to new narrative pages.
  • Write useful image alt text. Decorative images should normally be omitted rather than given meaningless alt text.

Edit docs/.vitepress/navigation.mjs as the navigation source. SUMMARY.md, docs/SUMMARY.md, and docs/en/SUMMARY.md are generated by scripts/sync-navigation.mjs.

Edit Chinese word lists under docs/threads/word-list/; English list pages are generated. Edit docs/README.md; the root README.md mirror is generated with repository-relative links.

CI rejects unsynchronised generated files.

Privacy and Media

  • Do not submit precise location, identity documents, private contact details, private messages, health records, customer/student data, or secrets.
  • Obtain explicit permission before publishing identifiable third parties, especially children, former partners, patients, students, employees, or bystanders.
  • Strip EXIF, GPS, device, and capture-time metadata before committing media.
  • Document source and redistribution permission in ATTRIBUTIONS.md.
  • Prefer WebP for photographic images; keep text and diagrams as accessible SVG or optimised PNG where appropriate.

For a privacy concern already present in the repository, use the private process in SECURITY.md, not a public issue.

Pull Request Description

Explain the problem, evidence/source, changed pages and both languages, privacy/licensing impact, and commands run. Screenshots are useful for layout changes at 375px and 1280px.

By contributing, you agree that content is contributed under CC BY-NC 4.0 and code under MIT according to LICENSE.md, unless a file clearly states another compatible license.