Spec files in this folder follow one of these naming patterns:
{ISSUE_NUMBER}-{short-description}.md
Example:
1875-review-lto-fat-in-dev-profile.md
{EPIC_ISSUE_NUMBER}-{short-description}.md
Example:
1978-configuration-overhaul-epic.md
{SUB_ISSUE_NUMBER}-{EPIC_ISSUE_NUMBER}-{short-description}.md
Where:
{SUB_ISSUE_NUMBER}— GitHub issue number of the subissue itself{EPIC_ISSUE_NUMBER}— GitHub issue number of the parent EPIC
Example:
1979-1978-copy-configuration-schema-v2-to-v3-baseline.md
An optional si-{N} segment can be added between the EPIC number and the description when
the implementation order within the EPIC is significant and worth surfacing in the filename:
{SUB_ISSUE_NUMBER}-{EPIC_ISSUE_NUMBER}-si-{ORDER}-{short-description}.md
Where:
si-{N}— "subissue N" in the EPIC's implementation order
Example:
1969-1938-si-8-eliminate-unwraps-from-rest-api-client.md
The most important part is the issue number prefix. It makes it easy to locate any spec from a GitHub issue number and vice versa. Always start the filename with the GitHub issue number.
| Pattern | Example |
|---|---|
| Standalone | 1875-review-lto-fat-in-dev-profile.md |
| EPIC | 1978-configuration-overhaul-epic.md |
| Subissue | 1979-1978-copy-configuration-schema-v2-to-v3-baseline.md |
| Subissue with order | 1969-1938-si-8-eliminate-unwraps-from-rest-api-client.md |