Stable requirement item ids and checked references to items and PlanningItem questions (REQ-X#item, PI-Y#Q31)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
調査の方向性
Start with the structured questions work in related issue #436 and the reference lint work in #74, then trace how validate, lint-docs, and refs resolve element ids. Check how Requirements and PlanningItem questions are represented before choosing between the proposed stable ids and structured items. Done means item and question references resolve, missing or open references produce the specified warnings, and item-level impact identifies only citing elements.
索引モデルが issue の本文から書いたものです。
説明
Problem
Requirements are commonly written as numbered items ("1. … 2. …"), and other elements cite them in prose as REQ-X item 5, and planning-item questions as PI-Y Q31. check-ref and lint-docs resolve element ids, but not the item or question part, so:
- a reference to an item that does not exist (or moved after an insertion) is not reported;
- inserting an item renumbers the rest and silently breaks every citation;
- an element that cites a question that is still open (e.g. "owner to confirm, Q13") is not flagged, so such markers stay after the question is answered.
Proposal
- Optional stable item ids inside a Requirement body (e.g.
1. {#grant-keys} **Server keys.** …, or a structureditems:list), rendered with their number. - Reference syntax for items and questions (
REQ-X#grant-keys,REQ-X item 5accepted as a legacy form,PI-Y#Q31), resolved byvalidate,lint-docsandrefs. - Warnings: reference to a missing item/question; reference to an open question from an element whose status is above draft; an answered question still cited with "to confirm"-style wording (heuristic, configurable).
impactand suspect links at item granularity: changing item 5 marks only elements citing item 5.
Related
#436 (questions are now structured, which makes #Qn resolution possible), #74 (lint-docs references).
- 主要言語
- Rust
- スター
- 8
- フォーク
- 1
- 平均マージ
- 3時間 26分
- マージ済み PR（30日）
- 66
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
sjames/syscribe のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
sjames/syscribe の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
max-sixty/worktrunk#4727 · コメント 7 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
follow-up
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
carrick-sh/carrick#1859 ·
メンテナーはふだん 1 日以内に返信
-
crate: spate-kafka documentation priority: medium
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信