Comcast / Comcast/sheens

Add property to spec to represent the version of the spec structure

Open
#36 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
122
Forks
27
PR merge metrics
No merged PRs in 30d

Description

This data would represent the version of the spec _structure_, not the version of the spec itself. For example, in Sheens 1.0, the spec structure version might just be that same `1.0`. My joke-telling spec, which is written for (say) `specFormat: "1.0"`, could have `"version":"3.4.5"`.

So the proposal here is to add `specFormat`, with string values, as an optional spec property.

Also see #35.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named in the issue. Read issue #35 first, then locate the repository's spec representation and validation paths; done means specs can optionally carry a string-valued specFormat that distinguishes structure versions from spec versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.