Add a code coverage badge to CI
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 62/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- github-actions, go
- 領域
- ci-cd, documentation
調査の方向性
.github/workflows/ci.yml の単一のジョブ build-test と、README の 15 行目にある CI バッジから始めてください。go test -coverprofile=coverage.out ./... を追加し、go tool cover -func で合計値を読み取ってください。その後、main への push のみで実行され、contents: write を必要とするステップを追加してください。オプション A の文章は文字化けしているため、どのバッジのオプションを使うかはメンテナーに確認してください。完了条件は、すべての PR でカバレッジが実行されること、バッジが main でのみ更新されること、そして README で CI バッジの隣に表示されることです。
索引モデルが issue の本文から書いたものです。
説明
What
Measure test coverage in CI and surface it as a badge in the README, next to the existing CI badge.
Current state
.github/workflows/ci.yml has one job, build-test, running go build ./..., go vet ./..., a gofmt check, and go test ./.... The README shows the CI badge at the top (line 15).
Proposed change
-
In CI, produce a coverage profile:
go test -coverprofile=coverage.out ./...- total via
go tool cover -func=coverage.out | tail -1(prints something liketotal: (statements) 62.3%).
-
Publish a badge — two options:
Option A — no third party (recommended, fits the project's local-first ethos).
Generate an SVG (for example withgithub.com/AlexBeauchemin/gobadge), commit it to abadgesbranch, and reference it:
coverage
The publish step needspermissions: contents: writeand should run only on push tomain. -
Add the chosen badge to the README next to the CI badge.
Acceptance criteria
- CI computes coverage on every push and PR.
- Badge renders in the README and updates on
main(not on every PR). - Existing CI steps (build, vet, gofmt, test) keep running unchanged.
- Note in the issue/PR that
internal/planandcmd/metcodehave no tests, so the percentage reflects that.
- 主要言語
- Go
- スター
- 1
- フォーク
- 2
- 平均マージ
- 1時間 31分
- マージ済み PR（30日）
- 7
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Edwin-metcalf/MetCode のほかの issue
-
bug good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
Edwin-metcalf/MetCode#18 ·
-
enhancement good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Edwin-metcalf/MetCode#16 ·
-
testing
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
Edwin-metcalf/MetCode#9 ·
-
Add a Makefileオープンenhancement good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Edwin-metcalf/MetCode#8 ·
-
Add a --host flagオープンenhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Edwin-metcalf/MetCode#7 ·
Edwin-metcalf/MetCode の issue をすべて見る
似ている issue
-
documentation hacktoberfest priority: low skill: good first issue status: ready for dev
難易度 2/5 半日 初心者へのやさしさ 85/100
hyperledger-labs/fabric-smart-client#2142 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
numberly/vault-db-injector#107 ·
メンテナーはふだん 1 日以内に返信
-
area/import kind/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
[DOC] Wrong sg_egress_ports range in the Terraform Databricks Guide for AWS Hub & Spoke with Network Firewall対応中かも @akhil9tiet が今日担当しました。 オープンdocs
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
databricks/terraform-provider-databricks#6080 · コメント 1 件 ·
メンテナーはふだん 3 日以内に返信
-
spqr-coordinator usage shows 'run --config', but 'run' is not a subcommand (unknown command "run")オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
pg-sharding/spqr#3092 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信