docs(notifications): TODO.md claims Discord/Teams/Telegram/Google Chat providers exist — they don't

Đang mở
  • Có gì không ổn?
#635 1 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
78/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
backend

Hướng nghiên cứu

Bắt đầu với packages/notifications/src/providers/slack.ts và webhook.ts, sau đó kiểm tra packages/notifications/src/types.ts, client.ts và các bài kiểm thử hiện có của Slack provider. Thêm Discord provider cùng với phần wiring của client/type theo cùng một mẫu, cập nhật packages/notifications/TODO.md để phản ánh phạm vi đã triển khai và xác minh rằng các bài kiểm thử tập trung vào Discord đều đạt.

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

Mô tả

Summary

packages/notifications/TODO.md checks off Discord, Microsoft Teams, Telegram, and Google Chat as [x] done:

- [x] **Slack** - Webhook support
- [x] **Discord** - Webhook support
- [x] **Email** - Injected send function
- [x] **Webhook** - Generic HTTP webhook
- [x] **Microsoft Teams** - Adaptive Cards via webhook
- [x] **Telegram** - Bot API (sendMessage)
- [x] **Google Chat** - Cards via webhook

But packages/notifications/src/providers/ only contains slack.ts, email.ts, webhook.ts, and base.ts — no matching files for the other four. NotificationChannel (packages/notifications/src/types.ts:1) is typed "slack" | "email" | "webhook" only, and NotificationClient (packages/notifications/src/client.ts) only wires those three up. The alarms-system section of the same TODO.md (line 13) still lists discord/teams/telegram/google-chat as channels an alarm should be able to target, so this looks like real missing functionality rather than just stale docs.

Proposal

Add a Discord provider (webhook-based, mirroring the existing SlackProvider) as a first, self-contained slice:

  • New providers/discord.ts following the SlackProvider/WebhookProvider pattern
  • Extend NotificationChannel and wire it into NotificationClient
  • Tests mirroring the existing Slack provider tests
  • Fix the TODO.md checkboxes to reflect reality

Keeping this scoped to Discord only — happy to do Teams/Telegram/Google Chat as separate follow-up PRs if this shape is right, rather than one big PR.

Checking scope/interest before opening a PR, per the AI policy here — let me know if this is wanted or if there's context I'm missing (e.g. planned elsewhere / superseded by a different design).

Disclosure: I used Claude Code to grep the providers directory against TODO.md and the type definitions; verified manually before writing this up.

Ngôn ngữ chính
TypeScript
Star
1.2k
Fork
227
Không có pull request nào được merge trong 30 ngày

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 tương tự

Thêm issue về TypeScript

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.