Skip to content

Standardize experimental findings format with a contribution template #50

@olaservo

Description

@olaservo

Background

Experimental Findings contains valuable implementation results but the entries vary in structure. McpGraph has findings/resolution/concerns, worfcat's comparison uses a numbered list with results per approach, and others are brief paragraphs. As more contributors add findings (#37, #38, #40, #41, #42), a consistent template will make entries comparable and ensure nothing important is omitted.

Scope

  1. Design a findings template covering:

    • Implementation: Name, repo URL, author
    • Approach tested: Which approach(es) from docs/approaches.md does this map to?
    • Setup: Clients tested, models tested, configuration notes
    • What was tested: Specific scenarios or behaviors evaluated
    • Results: What worked, what didn't, what was surprising
    • Requirements addressed: Which requirements (from docs/requirements.md) does this provide evidence for?
    • Limitations: What remains untested or uncertain
    • Date: When testing was performed (relevant as clients and models evolve)
  2. Add the template to either:

    • A new section at the top of docs/experimental-findings.md, or
    • A separate docs/findings-template.md referenced from CONTRIBUTING.md
  3. Retrofit at least 2 existing entries to demonstrate the format (McpGraph and worfcat's comparison are good candidates).

  4. Update CONTRIBUTING.md with guidance on using the template when adding findings.

Acceptance Criteria

  • Template documented and accessible
  • At least 2 existing findings retrofitted to the template
  • CONTRIBUTING.md updated with instructions for submitting findings
  • Template reviewed by at least 1 facilitator

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions