Skip to content

Problem: contributors can't tell which spec format to use #118

Description

@zolotokrylin

Problem

docs/CONTRIBUTING.md documents this Spec format:

---
goal: <link to Goal issue>
---

# Feature Name

## Overview

What this Goal enables for users.

But the format already used across multiple repos is different — Objective, Key Results, Users, and Core Concepts (with user-facing methods per concept):

Contributors writing a new spec can't tell which format is actually expected.

Solution

Update the Format section of docs/CONTRIBUTING.md to document the Objective / Key Results / Users / Core Concepts structure, with a short example, so the docs match the norm already in use.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Fields

    No fields configured for Problem.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions