Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add a code coverage badge to CI

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#19 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
62/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, go
Lĩnh vực
ci-cd, documentation

Hướng nghiên cứu

Bắt đầu từ job duy nhất build-test trong .github/workflows/ci.yml và badge CI ở dòng 15 của README. Thêm go test -coverprofile=coverage.out ./... và đọc tổng với go tool cover -func, sau đó thêm một bước chỉ chạy khi push lên main và cần contents: write. Nội dung của Phương án A bị lỗi, vì vậy hãy xác nhận với maintainer nên dùng phương án badge nào. Hoàn thành khi coverage chạy trên mọi PR, badge chỉ cập nhật trên main và README hiển thị nó cạnh badge CI.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation enhancement help wanted
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

  1. In CI, produce a coverage profile:

    • go test -coverprofile=coverage.out ./...
    • total via go tool cover -func=coverage.out | tail -1 (prints something like total: (statements) 62.3%).

  2. Publish a badge — two options:

    Option A — no third party (recommended, fits the project's local-first ethos).
    Generate an SVG (for example with github.com/AlexBeauchemin/gobadge), commit it to a badges branch, and reference it:
    coverage
    The publish step needs permissions: contents: write and should run only on push to main.

  3. 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/plan and cmd/metcode have no tests, so the percentage reflects that.
Ngôn ngữ chính
Go
Star
1
Fork
2
Merge trung bình
1 giờ 31 phút
Pull request đã merge (30 ngày)
7

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Edwin-metcalf/MetCode

Tất cả issue của Edwin-metcalf/MetCode

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.