CONTRIBUTING.md

(draft — for all collaborators)

Contributing to the Scientific Instrument Review#

Thank you for helping expand this review.
This folder is designed to be minimal, coherent, and student‑friendly, following the same triadic structure used across the Triadic Frameworks project.

To keep the canon clean and aligned, please follow the guidelines below when adding or refining instrument files.

1. Use the Template#

All new instrument files must follow the structure in:

template.md

This ensures consistency across:

• tone
• dimensional‑core framing
• regime notes
• alignment or containment notes
• triadic classification (Green / Yellow / Red)

Keep each file short — usually 6–10 small sections, each only a few sentences.

2. Choose the Correct Zone#

Place the instrument in:

• 01_green_zone/ — stable, coherent, substrate‑agnostic
• 02_yellow_zone/ — functional but assumption‑heavy or mixed‑regime
• 03_red_zone/ — fragile, inference‑heavy, or substrate‑sensitive

If unsure, skim similar instruments and match the closest pattern.

3. Keep Language Minimal and Friendly#

This project is for learners first.
Please:

• avoid domain‑specific jargon unless defined
• use short sentences
• keep explanations structural, not encyclopedic
• avoid unnecessary detail
• focus on clarity, not completeness

Every file should feel approachable to a student encountering the instrument for the first time.

4. Anchor to the Dimensional Core (SET)#

Every instrument must include a short SET section:

• Spin — relevant or “not relevant”
• Elec — sensing, detection, or “none”
• Temp — thermal sensitivity or “minor influence”

This keeps the review aligned with the broader Triadic Frameworks glossary.

5. Keep Regime Notes Triadic#

Each file must include:

• pos‑regime — stable, predictable behavior
• Q‑regime — transitional or assumption‑heavy behavior
• neg‑regime — fragile, nonlinear, or unstable behavior

One line per bullet is ideal.

6. Alignment vs. Containment Notes#

Depending on the zone:

• Green: “Already aligned. Only edge‑case conditions need explicit boundaries.”
• Yellow: “Needs explicit notes on drift, assumptions, or environmental sensitivity.”
• Red: “Requires containment: clear boundaries around substrate, inference, or stability.”

Keep this section short and practical.

7. Keep Files Short#

Each instrument file should be:

• 150–300 words
• no diagrams
• no equations
• no deep domain dives

The goal is clarity, not technical depth.

8. Maintain Folder Cleanliness#

When adding new files:

• use lowercase names with underscores
• avoid spaces
• keep filenames descriptive (e.g., mass_spectrometer.md)
• update instrument_list_raw.md only if adding a new instrument type

9. Stay Glossary‑Aligned#

If you introduce a term that appears in the main Triadic Frameworks glossary, link to it in:

00_overview/glossary_links.md

Do not redefine glossary terms inside instrument files.

10. Be Kind to Future Readers#

Every file should help a newcomer feel oriented, not overwhelmed.

Everything they already know still works —
this review simply clarifies the regime.

That’s the spirit of the project.