Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

docs: README examples no longer match v0.21.0's output

オープン 初心者向け
  • 何か問題がありますか？
#261 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
77/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
go
領域
documentation

調査の方向性

README.mdで引用されたセクションから始めます。1472〜1525行付近の例、-V=fullの説明、不正なディレクティブの表、行番号の例を確認します。commit 510cad4でドキュメントに記載されたコマンドを実行し、その出力をREADMEの各ブロックと比較します。古い、または不完全な例や記述を更新し、行番号の表記規則を一つに定め、可能であればsurveyおよびinspectブロックのgolden testを追加します。ドキュメントに記載された出力と主張がコマンドと一致したら完了です。

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

説明

documentation P3

These were checked by running the commands at 510cad4.

Example output

  • "Silencing an unused report" (README.md:591-594): it runs plain declscope ./..., which is strict by default, but shows the loose wording nothing it reaches takes a scope. v0.21.0 prints …on B: it already has shared scope, and the same for T.F.

  • Survey and inspect samples (README.md:1472-1525): several numbers are out of date, and rows are silently left out.

    Item README v0.21.0
    Survey declared 20 29
    markdown → cell mutual empty yes
    markdown → cell reached 7 of 10 7 of 18
    markdown → sink 5 of 17, 28 uses 5 of 18, 25 uses
    golden → (core) 4 of 78 4 of 79
    format → json 2 of 105 2 of 107
    Open declarations 114 109

    The survey sample leaves out the Packages — qualify table. The inspect sample drops rows such as json → summary from the middle of the table, and cuts the "Declarations crossed" sentence short.

Statements

  • -V=full (README.md:227) says "A build from a checkout answers devel". go build in a checkout answers a VCS version. Only go run, or a build with -buildvcs=false, answers devel.

  • The malformed-directive table (README.md:628-630) gives one directive's message for another:

    Input README Actual
    //declscope:core twice duplicate declscope:namespace directive duplicate declscope:core directive
    Two identical ignores duplicate declscope:shared directive duplicate declscope:ignore directive
    A stray //declscope:core declscope:namespace must appear… declscope:core must appear…

  • Line numbers are counted two ways. Most examples treat the // file.go caption as outside the file (lines 114-115, 770-778, 1066 and 1159). The strict-fix example (534-537) and the account.go example (1100) count it as line 1.

Suggested fix

  • Regenerate the samples, or mark them as excerpts.
  • Use <name> in the message table.
  • Pick one convention for line numbers.
  • A golden test over the survey and inspect README blocks would keep them from drifting again.
主要言語
Go
スター
42
フォーク
1
平均マージ
1時間 18分
マージ済み PR（30日）
94

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

mpyw/declscope のほかの issue

mpyw/declscope の issue をすべて見る

似ている issue

Go の issue をもっと見る

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

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