123ishaTest / 123ishaTest/igt-docs

Headline "Requirements" aren't requirements, but features

オープン 初心者向け
#2 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
JavaScript
スター
5
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

説明

I was confused reading the docs where the subheadline of feature pages say "Requirements" but the list under it is a list of use cases, not requirements. Since `Feature` is already a class name in the tool (and so is `Requirements` for that matter), what about changing this headline to "Purpose" or "Benefits", "Advantages", "Properties", "Traits", etc. or something like that?

Example:

image

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

Look at the documentation pages for features in the project, likely in the docs/ directory. Find where the 'Requirements' headline is used and change it to a more accurate term like 'Purpose' or 'Benefits'. Verify the change by checking the rendered documentation locally or in a preview.

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
85/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。