mirror of
https://github.com/onestardao/WFGY.git
synced 2026-05-05 23:40:49 +00:00
Create README.md
This commit is contained in:
parent
f4cf0c65e8
commit
200d1fd3ef
1 changed files with 118 additions and 0 deletions
118
ProblemMap/Atlas/Fixes/community/reproduction-packs/README.md
Normal file
118
ProblemMap/Atlas/Fixes/community/reproduction-packs/README.md
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
<!--
|
||||
AI_NOTE_START
|
||||
|
||||
Document role:
|
||||
This file explains what belongs in the community reproduction-packs folder.
|
||||
|
||||
How to use this file:
|
||||
1. Read this page before adding any reproduction pack.
|
||||
2. Use this page to decide whether your contribution is really a reproduction pack.
|
||||
3. Use this page together with:
|
||||
- [Community Fix Lab](../README.md)
|
||||
- [Contribution Checklist](../../templates/contribution-checklist.md)
|
||||
|
||||
What this file is:
|
||||
- A folder-level guide for reproduction-oriented contributions
|
||||
- A scope filter for portable troubleshooting packs
|
||||
- A lightweight quality guide for compact reproducibility bundles
|
||||
|
||||
What this file is not:
|
||||
- Not a dump folder for random zip-style content
|
||||
- Not a place for undocumented asset bundles
|
||||
- Not a replacement for official demos
|
||||
|
||||
Reading discipline for AI:
|
||||
- Treat reproduction packs as practical community bundles, not frozen official demos.
|
||||
- Preserve the distinction between reproduction convenience and atlas core logic.
|
||||
|
||||
AI_NOTE_END
|
||||
-->
|
||||
|
||||
# Community Reproduction Packs
|
||||
|
||||
## Portable troubleshooting bundles and compact reproducibility packs
|
||||
|
||||
This folder is for community-contributed packs that help others reproduce a routing result, repair idea, or troubleshooting demonstration with minimal friction.
|
||||
|
||||
Typical contributions here include:
|
||||
|
||||
- compact reproduction bundles
|
||||
- case-plus-artifact packs
|
||||
- route-and-repair mini kits
|
||||
- rerun-ready portable folders
|
||||
- small reproducibility bundles for one family or one case
|
||||
|
||||
---
|
||||
|
||||
## What belongs here
|
||||
|
||||
Good reproduction packs include:
|
||||
|
||||
- one compact case bundle
|
||||
- one reproducible route-and-repair kit
|
||||
- one small teaching bundle for a boundary case
|
||||
- one portable rerun pack
|
||||
- one notebook-plus-fixture mini package
|
||||
|
||||
A good pack should be:
|
||||
|
||||
- clearly named
|
||||
- easy to inspect
|
||||
- small enough to reuse
|
||||
- explicit about included files
|
||||
- explicit about expected result
|
||||
|
||||
---
|
||||
|
||||
## What does not belong here
|
||||
|
||||
Please do not use this folder for:
|
||||
|
||||
- giant archive-like dumps
|
||||
- undocumented asset bundles
|
||||
- unclear collections of unrelated files
|
||||
- packs with no route context
|
||||
- packs that claim official status without review
|
||||
|
||||
---
|
||||
|
||||
## Suggested pack pattern
|
||||
|
||||
A useful reproduction pack usually includes:
|
||||
|
||||
1. one short README
|
||||
2. case description
|
||||
3. included files list
|
||||
4. how to run or inspect it
|
||||
5. expected result
|
||||
6. limits or warnings
|
||||
|
||||
That is enough to make the pack useful for others.
|
||||
|
||||
---
|
||||
|
||||
## Suggested naming style
|
||||
|
||||
Examples:
|
||||
|
||||
- `f1-grounding-reproduction-pack-v1/`
|
||||
- `f4-execution-closure-reproduction-pack-v1/`
|
||||
- `f7-container-fidelity-reproduction-pack-v1/`
|
||||
|
||||
Use folders when multiple files are required.
|
||||
|
||||
---
|
||||
|
||||
## Before contributing
|
||||
|
||||
Please read:
|
||||
|
||||
- [Community Fix Lab](../README.md)
|
||||
- [Contribution Checklist](../../templates/contribution-checklist.md)
|
||||
- [Flagship Fix Demos v1](../../official/flagship-fix-demos-v1.md)
|
||||
|
||||
---
|
||||
|
||||
## One-line status
|
||||
|
||||
**This folder holds community reproduction bundles that make atlas-guided troubleshooting easier to share, rerun, and reuse.**
|
||||
Loading…
Add table
Add a link
Reference in a new issue