1- # Contributing to the FlyPython catalog
1+ # Contributing to FlyPython
22
3- FlyPython maintains a bilingual, reviewed source catalog used by
4- [ flypython.com] ( https://flypython.com/ ) . Contributions should improve source
5- quality, factual accuracy, or the maintenance workflow. General Python questions
6- belong in [ GitHub Discussions] ( https://github.com/flypythoncom/python/discussions ) .
3+ FlyPython maintains bilingual Python engineering guides, task playbooks,
4+ runnable examples, templates, and a reviewed source catalog used by
5+ [ flypython.com] ( https://flypython.com/ ) . Contributions should help a visitor
6+ complete a real Python task or improve factual accuracy and maintainability.
7+ General Python questions belong in
8+ [ GitHub Discussions] ( https://github.com/flypythoncom/python/discussions ) .
79
810Read the [ curation policy] ( docs/CURATION_POLICY.md ) before contributing.
911
@@ -19,12 +21,20 @@ to submit and retain required third-party notices.
1921Use the matching issue form before a larger change:
2022
2123- ** Resource proposal** for a new official source.
24+ - ** Project proposal** for a current Python project that should receive human
25+ review for Project Radar.
2226- ** Broken link** for an unreachable or replaced resource.
2327- ** Security report** for a vulnerability; follow [ SECURITY.md] ( SECURITY.md )
2428 instead of opening a public issue.
2529
2630Small typo, metadata, or tooling fixes may go directly to a focused pull request.
2731
32+ First-party guides and playbooks must remain practical, testable, and aligned
33+ in English and Chinese. A content change must update both language files with
34+ the same content version and review date, then regenerate
35+ ` content-manifest.json ` . Do not present generated code, a passing test, or a
36+ deployment command as proof of user value or production readiness.
37+
2838## Catalog sources
2939
3040The canonical source is the ` catalog/ ` directory:
@@ -67,6 +77,8 @@ After changing catalog sources, regenerate the public export:
6777
6878``` bash
6979python tools/export_catalog.py
80+ python tools/render_readmes.py
81+ python tools/build_content_manifest.py
7082```
7183
7284Run the same deterministic checks as CI:
@@ -75,6 +87,9 @@ Run the same deterministic checks as CI:
7587python -m pytest
7688python tools/validate_catalog.py
7789python tools/export_catalog.py --check
90+ python tools/render_readmes.py --check
91+ python tools/build_content_manifest.py --check
92+ python tools/verify_examples.py
7893```
7994
8095Maintainers can run the networked link audit through GitHub Actions. For a
@@ -90,7 +105,7 @@ justify removing a resource.
90105
91106## Pull request checklist
92107
93- - Keep source data and the generated ` catalog.json ` consistent.
108+ - Keep source content and generated JSON exports consistent.
94109- Preserve English and Chinese meaning.
95110- Include evidence for maintenance, ownership, access, and safety claims.
96111- Do not call a project production-ready without current evidence.
0 commit comments