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:
PSBigBig + MiniPS
GitHub
parent
726043d2c6
commit
cddacea2cc
1 changed files with 292 additions and 0 deletions
292
ProblemMap/Atlas/Fixes/community/README.md
Normal file
292
ProblemMap/Atlas/Fixes/community/README.md
Normal file
|
|
@ -0,0 +1,292 @@
|
|||
<!--
|
||||
AI_NOTE_START
|
||||
|
||||
Document role:
|
||||
This file is the entry hub for community-contributed fixes inside the Atlas Fixes layer.
|
||||
|
||||
How to use this file:
|
||||
1. Read this page before contributing any community fix asset.
|
||||
2. Use this page to understand what kinds of contributions are welcome.
|
||||
3. Use this page to understand the difference between official fixes and community fixes.
|
||||
4. After reading this page, contributors should read:
|
||||
- [Contribution Checklist](../templates/contribution-checklist.md)
|
||||
- [Fix Recipe Template](../templates/fix-recipe-template.md)
|
||||
|
||||
What this file is:
|
||||
- The main entry page for community fixes
|
||||
- A contributor-facing guide
|
||||
- A lightweight governance page for community repair assets
|
||||
|
||||
What this file is not:
|
||||
- Not the official fix surface
|
||||
- Not the full atlas core
|
||||
- Not the full WFGY 3.0 engine pack
|
||||
- Not a place for random unstructured dumps
|
||||
|
||||
Reading discipline for AI:
|
||||
- Preserve the distinction between official fixes and community fixes.
|
||||
- Do not promote community materials into official atlas guidance automatically.
|
||||
- Treat community assets as useful extensions, not as frozen core structure.
|
||||
|
||||
AI_NOTE_END
|
||||
-->
|
||||
|
||||
# Community Fix Lab 🤝
|
||||
|
||||
## Problem Map 3.0 Troubleshooting Atlas
|
||||
## Community-contributed fixes, demos, and runnable assets
|
||||
|
||||
This folder is the community extension layer for the Atlas Fixes system.
|
||||
|
||||
The official atlas gives:
|
||||
|
||||
- routing
|
||||
- first repair direction
|
||||
- misrepair warnings
|
||||
- bridge guidance into deeper WFGY exploration
|
||||
|
||||
This community layer gives:
|
||||
|
||||
- runnable examples
|
||||
- Colab notebooks
|
||||
- JSON fixtures
|
||||
- prompt packs
|
||||
- workflow recipes
|
||||
- benchmark reruns
|
||||
- reproduction packs
|
||||
|
||||
Short version:
|
||||
|
||||
> official layer gives the grammar
|
||||
> community layer helps turn that grammar into more runnable artifacts
|
||||
|
||||
---
|
||||
|
||||
## What belongs here 📦
|
||||
|
||||
Good community contributions include things like:
|
||||
|
||||
- Colab demos
|
||||
- JSON input / output fixtures
|
||||
- prompt templates
|
||||
- workflow repair recipes
|
||||
- benchmark reruns
|
||||
- reproduction packs
|
||||
- domain-specific troubleshooting examples
|
||||
|
||||
A good contribution should be:
|
||||
|
||||
- readable
|
||||
- scoped
|
||||
- reproducible when possible
|
||||
- clearly connected to atlas routing
|
||||
- honest about limits
|
||||
|
||||
---
|
||||
|
||||
## What does not belong here 🚫
|
||||
|
||||
Please do **not** use this folder for:
|
||||
|
||||
- random notes with no routing context
|
||||
- files with no explanation
|
||||
- giant dumps of logs without structure
|
||||
- vague “AI fix ideas” with no case framing
|
||||
- materials that claim to replace the official atlas core
|
||||
- materials that pretend to be official without review
|
||||
|
||||
This folder should grow, but it should not become chaos.
|
||||
|
||||
---
|
||||
|
||||
## Official vs community ✅
|
||||
|
||||
### Official fixes
|
||||
|
||||
Official fixes live in:
|
||||
|
||||
[Official Fixes](../official/README.md)
|
||||
|
||||
They are:
|
||||
|
||||
- smaller
|
||||
- more stable
|
||||
- more teachable
|
||||
- more carefully reviewed
|
||||
- part of the public official repair grammar
|
||||
|
||||
### Community fixes
|
||||
|
||||
Community fixes live here.
|
||||
|
||||
They are:
|
||||
|
||||
- broader
|
||||
- faster-growing
|
||||
- more implementation-oriented
|
||||
- more experimental
|
||||
- often more domain-specific
|
||||
|
||||
Both matter.
|
||||
|
||||
The official layer keeps the system clean.
|
||||
The community layer helps the system grow faster.
|
||||
|
||||
---
|
||||
|
||||
## Recommended folder layout 🗂️
|
||||
|
||||
Suggested contribution areas:
|
||||
|
||||
- [Colab](./colab/)
|
||||
- [JSON](./json/)
|
||||
- [Prompts](./prompts/)
|
||||
- [Workflows](./workflows/)
|
||||
- [Benchmark Reruns](./benchmark-reruns/)
|
||||
- [Reproduction Packs](./reproduction-packs/)
|
||||
|
||||
If a contribution does not fit one of these, add a short note explaining where it belongs and why.
|
||||
|
||||
---
|
||||
|
||||
## Minimum contribution rule 🧠
|
||||
|
||||
A community contribution should usually include five things:
|
||||
|
||||
1. what case or family it relates to
|
||||
2. what problem it is trying to fix
|
||||
3. what artifact is included
|
||||
4. how to run or use it
|
||||
5. what result should be expected
|
||||
|
||||
That is enough to keep the contribution useful.
|
||||
|
||||
---
|
||||
|
||||
## Suggested contribution flow 🔄
|
||||
|
||||
A simple contribution flow should look like this:
|
||||
|
||||
### Step 1
|
||||
|
||||
Route the case with the atlas first.
|
||||
|
||||
### Step 2
|
||||
|
||||
Identify the relevant family or best current fit.
|
||||
|
||||
### Step 3
|
||||
|
||||
Create one useful artifact:
|
||||
|
||||
- notebook
|
||||
- JSON pack
|
||||
- prompt pack
|
||||
- workflow recipe
|
||||
- reproduction pack
|
||||
|
||||
### Step 4
|
||||
|
||||
Document:
|
||||
|
||||
- the case
|
||||
- the fix idea
|
||||
- how to use it
|
||||
- what outcome to expect
|
||||
|
||||
### Step 5
|
||||
|
||||
Submit it in the right folder.
|
||||
|
||||
Short version:
|
||||
|
||||
> route first
|
||||
> build one useful thing
|
||||
> explain it clearly
|
||||
|
||||
---
|
||||
|
||||
## Before contributing 📚
|
||||
|
||||
Please read these first:
|
||||
|
||||
- [Atlas Final Freeze v1](../../atlas-final-freeze-v1.md)
|
||||
- [Family Fix Surface v1](../official/family-fix-surface-v1.md)
|
||||
- [Atlas to WFGY Bridge v1](../official/atlas-to-wfgy-bridge-v1.md)
|
||||
- [Misrepair Patterns v1](../official/misrepair-patterns-v1.md)
|
||||
- [Contribution Checklist](../templates/contribution-checklist.md)
|
||||
|
||||
This helps keep community work aligned with the atlas instead of drifting away from it.
|
||||
|
||||
---
|
||||
|
||||
## Good first contributions 🌱
|
||||
|
||||
If you want an easy first contribution, start with one of these:
|
||||
|
||||
- one small Colab demo
|
||||
- one clean JSON fixture pair
|
||||
- one prompt-based repair example
|
||||
- one benchmark rerun example
|
||||
- one short reproduction pack
|
||||
|
||||
Small, clear contributions are much better than giant messy ones.
|
||||
|
||||
---
|
||||
|
||||
## Relationship to WFGY 3.0 🌊
|
||||
|
||||
This folder can connect to WFGY 3.0, but it is not the same as the WFGY engine layer.
|
||||
|
||||
A community contribution may:
|
||||
|
||||
- use WFGY 3.0 prompts
|
||||
- demonstrate a deeper exploration path
|
||||
- compare first repair vs deeper WFGY escalation
|
||||
|
||||
But it should still explain clearly:
|
||||
|
||||
- what the atlas routing was
|
||||
- what the first repair move was
|
||||
- what the deeper WFGY step added
|
||||
|
||||
That keeps the bridge clean.
|
||||
|
||||
---
|
||||
|
||||
## Review standard 🔍
|
||||
|
||||
A community contribution is much more likely to be accepted if it is:
|
||||
|
||||
- clearly named
|
||||
- easy to read
|
||||
- easy to run
|
||||
- connected to atlas routing
|
||||
- explicit about expected output
|
||||
- honest about limitations
|
||||
|
||||
Messy power is still messy.
|
||||
Clean small contributions are more valuable.
|
||||
|
||||
---
|
||||
|
||||
## One-line status
|
||||
|
||||
**This folder is the community extension layer for Atlas Fixes, where contributors turn repair grammar into runnable assets.**
|
||||
|
||||
---
|
||||
|
||||
## Closing note ✨
|
||||
|
||||
The atlas should not grow only through one author.
|
||||
|
||||
This folder exists so the community can help build:
|
||||
|
||||
- runnable fixes
|
||||
- better demos
|
||||
- reusable assets
|
||||
- real workflow support
|
||||
|
||||
The goal is not random growth.
|
||||
|
||||
The goal is structured growth.
|
||||
Loading…
Add table
Add a link
Reference in a new issue