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

Contributors: leaderboard endpoint with period filters (Phase 5.3)

Đang mở
  • Có gì không ổn?
#8 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
csharp, postgresql
Lĩnh vực
backend-api-design, databases

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra dependency #6, sau đó lần theo pattern của endpoint module thông qua IEndpointModule.MapEndpoints và public contract hiện có của Members/Identity. Đọc các pattern của ContributionEvent và MembersTestHarness.cs trước khi thêm coverage của xUnit dưới tests/CommunityPro.Tests//. Hoàn tất nghĩa là có response ẩn danh được phân trang, thứ hạng xác định, coverage cho ranh giới kỳ theo UTC, ánh xạ lỗi ổn định và dữ liệu profile chỉ dành cho thành viên đang hoạt động.

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

Mô tả

contributors

Scope

GET /contributors?period=all|90d|30d (anonymous, paginated) returning the ranked leaderboard the Top Contributors page renders (ISR, revalidate 300s).

Shape

{ "rank": 1, "login": "octocat", "avatarUrl": "…", "memberId": "…|null", "displayName": "…|null", "mergedPrs": 42 }

Rules

  • Aggregate with a plain grouped query over ContributionEvent first (materialize into a contributor_stats view/table only if it proves slow — don't pre-optimize).
  • Join to member profiles via GithubUserId through a public module contract on the Members/Identity side (e.g. a bulk lookup IReadOnlyDictionary<long, MemberRef> by GitHub id) — no cross-module DbContext access.
  • Non-member org contributors still appear (login + GitHub avatar, memberId: null). Deactivated members appear as non-members (no profile link).
  • Period boundaries computed in UTC off MergedAt.

Error codes

contributors.invalid_period

Dependencies

Blocked by #6. Backfill #7 makes the data real but isn't a code dependency.

Acceptance criteria

  • Ranking is stable (ties broken deterministically, e.g. earliest merge first)
  • Period filters tested at the boundary (e.g. a PR merged exactly 90d ago)
  • Member join returns profile info only for active members
  • Paginated; default page size sensible (~20)
Conventions (project-wide, non-negotiable)
  • .NET 9, records for immutable shapes, file-scoped namespaces, primary constructors where they read well. Minimal-API endpoints grouped per module via IEndpointModule.MapEndpoints.
  • Result<T> (SharedKernel) instead of exception-driven control flow. Endpoint results map failures to ProblemDetails with the stable error codes listed above — the frontend keys off them.
  • Module owns its EF Core DbContext mapped to its own Postgres schema. Modules never reference each other's internals — cross-module needs go through a public contract interface or an in-process domain event (IEventPublisher).
  • All external calls (GitHub, Stripe, Brevo, Cloudinary, Meilisearch) behind interfaces owned by the consuming module.
  • Every list endpoint paginated (offset is fine). xUnit tests in tests/CommunityPro.Tests/<Module>/ following the existing harness patterns (see Members/MembersTestHarness.cs).
Ngôn ngữ chính
C#
Star
0
Fork
0
Không có pull request nào được merge trong 30 ngày

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

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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 CommunityPro/community-pro-api

Tất cả issue của CommunityPro/community-pro-api

Issue tương tự

Thêm issue về C#

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.