WFGY/ProblemMap/Atlas/Fixes/templates/README.md
PSBigBig + MiniPS fef38f1a32
Update README.md
2026-03-16 17:56:13 +08:00

8.5 KiB

Templates Hub 🧩

Problem Map 3.0 Troubleshooting Atlas

Reusable templates for community fix contributions

Quick links:


This folder contains the reusable templates for the community fixes layer.

If the Community Fix Lab tells you where contributions belong, this page helps you choose the right template so the contribution stays clear, reviewable, and reusable

Its job is simple:

help contributors submit clearer, smaller, more reviewable fix assets

These templates are here to reduce chaos and make it easier to grow the fix ecosystem.


Quick start 🚀

I already know what I want to submit

Use this path:

  1. choose the matching template
  2. draft one small contribution
  3. check it with the Contribution Checklist
  4. attach any supporting files
  5. submit it in the right community folder

I do not know which template to use yet

Use this path:

  1. scan the Template quick map
  2. identify your main artifact type
  3. choose one main template
  4. keep the contribution small and scoped
  5. use the checklist before submitting

Short version:

choose one main artifact
use one clear template
keep it small
explain expected output 🛠️


Template quick map 🗂️

Template Best for Typical output
Contribution Checklist pre-submit review scope, clarity, routing, reproducibility check
Fix Recipe Template repair guidance short fix writeup or repair recipe
Prompt Template prompt-based assets system prompt, user prompt, repair prompt pack
Colab Template notebook demos runnable walkthrough or replay notebook
JSON Template structured data fixture, expected output, config pack

What this folder is for 🎯

Use this folder when you want to create a new community contribution such as:

  • a fix recipe
  • a prompt pack
  • a Colab notebook
  • a JSON fixture
  • a workflow example
  • a reproduction pack

If you are not sure where to start, start here.


How to use this hub 📚

Fast path

If you want the shortest practical route:

  1. identify your main artifact type
  2. open the matching template
  3. draft one small contribution
  4. run the Contribution Checklist
  5. submit it in the right folder

Full path

If you want the fuller contributor flow:

  1. Community Fix Lab
  2. this page
  3. choose the right template
  4. Contribution Checklist
  5. submit the contribution in the right community folder

Available templates 🧩

1. Contribution Checklist

Use this first or use it before submission.

This file helps you check whether your contribution is:

  • clear
  • scoped
  • routed
  • usable
  • honest about limits

2. Fix Recipe Template

Use this when your contribution is mainly a repair recipe.

Good for:

  • first repair move writeups
  • small runnable fix notes
  • workflow repair guides
  • practical repair instructions

3. Prompt Template

Use this when your contribution is mainly prompt-based.

Good for:

  • system prompts
  • user prompts
  • routing prompts
  • repair-first prompts
  • trace-exposure prompts

4. Colab Template

Use this when your contribution is mainly notebook-based.

Good for:

  • Colab demos
  • repair notebooks
  • before / after notebook comparisons
  • benchmark rerun notebooks

5. JSON Template

Use this when your contribution needs structured machine-readable data.

Good for:

  • fixtures
  • baseline inputs
  • expected outputs
  • evaluation packs
  • demo configs

Which template should I use 🤔

Use this quick guide.

If your main asset is text guidance

Use:

If your main asset is a prompt

Use:

If your main asset is a notebook

Use:

If your main asset is structured data

Use:

If your contribution mixes several asset types, choose the main one first, then attach the others as supporting files.


What a good first contribution looks like 🌱

A strong first contribution usually looks like this:

  • one family
  • one case
  • one main artifact
  • one expected result
  • one short explanation

For example:

  • one small Colab demo
  • one clean JSON fixture pair
  • one route-aware prompt example
  • one short workflow recipe

Small and clear beats big and messy almost every time.


Minimum good contribution rule

A good contribution usually has:

  • routing context
  • one clear problem
  • one useful artifact
  • short usage instructions
  • expected result
  • one misrepair warning
  • honest limitations

That is enough to be useful.


What not to do 🚫

Please do not use these templates to submit:

  • giant vague idea dumps
  • unstructured logs
  • random files with no routing context
  • prompt collections with no explanation
  • notebooks with no before / after logic
  • JSON files with no meaning

The goal is structured growth, not file pile-up.


Relationship to official fixes 🌉

These templates are for the community layer.

Official fix documents live in:

Community assets can be very valuable, but they do not automatically become official atlas guidance.

That distinction should stay clear.


Before you submit 📌

Must read

Please read these first:

Good to read

These are strongly recommended if you want stronger alignment:

This keeps community work aligned with the atlas instead of drifting away from it.


One-line status

This folder contains the reusable templates that help community fix contributions stay structured and reviewable.


Next steps

After this page, most readers continue with:

  1. Open Contribution Checklist
  2. Open Fix Recipe Template
  3. Back to Community Fix Lab
  4. Back to Official Fixes

If you want to return to the broader product surface:

If this template hub helps your workflow, consider:


Closing note

If the atlas is going to grow through the community, it needs good templates.

That is what this folder is for.

The goal is not random growth.

The goal is structured growth.