|
| 1 | +# FlyPython repository guide |
| 2 | + |
| 3 | +## Mission |
| 4 | + |
| 5 | +This repository is the broad, community-maintained resource catalog behind |
| 6 | +FlyPython. Keep `flypython.com` focused on editorial learning paths and a small |
| 7 | +featured set; keep this repository focused on the larger reviewed catalog and |
| 8 | +its contribution workflow. |
| 9 | + |
| 10 | +## Content rules |
| 11 | + |
| 12 | +- Prefer official documentation and primary sources. |
| 13 | +- Every catalog entry must include a stable ID, path, source type, level, |
| 14 | + rationale, review date, status, and any key or safety requirements. |
| 15 | +- Do not call a project production-ready without current maintenance, licensing, |
| 16 | + security, and adoption evidence. |
| 17 | +- Do not use an LLM or web-search API to generate resource descriptions. |
| 18 | + Descriptions and classifications require human review. |
| 19 | +- Keep English and Chinese pages generated from the same canonical resource |
| 20 | + data. Do not hand-copy the full catalog into multiple Markdown files. |
| 21 | +- Treat HTTP 403, 429, and transient 5xx responses as review-needed states, not |
| 22 | + automatic proof that a resource is broken. |
| 23 | + |
| 24 | +## Change workflow |
| 25 | + |
| 26 | +- Work on a feature branch and preserve unrelated contributor changes. |
| 27 | +- Run the repository validation workflow before committing. |
| 28 | +- Keep external-link checks read-only, rate-limited, retryable, and blocked from |
| 29 | + private or loopback network targets. |
| 30 | +- Do not add API keys, tokens, analytics IDs, or generated reports to git. |
| 31 | +- After merge, verify the GitHub Pages deployment and the production domain. |
| 32 | + |
| 33 | +## Review priorities |
| 34 | + |
| 35 | +1. Content accuracy and source quality. |
| 36 | +2. Deterministic generation and bilingual parity. |
| 37 | +3. Build, schema, link, accessibility, and SEO checks. |
| 38 | +4. Clear contribution and licensing boundaries. |
0 commit comments