Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Add `WebhookNotifier.SUPPORTED_EVENTS` and a `--strict` guard holding `webhook_schema.md`'s event table to the emission sites

未关闭
#918 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
markdown, python
领域
backend, devtools

调研方向

Start with forgelm/webhook.py, where the event names must become a SUPPORTED_EVENTS frozenset, and with the eight-event table in docs/reference/webhook_schema.md (EN and TR). Use tools/check_audit_event_catalog.py as the pattern for the new tools/check_webhook_event_vocabulary.py --strict guard. Done when the guard fails on any mismatch between the docs and the emission sites, and the row at docs/roadmap/risks-and-decisions.md:264 is removed with its ID F-PR54-M10-followup in the CHANGELOG. Coordinate with #671 on the overlapping guard half.

由索引模型根据 Issue 内容生成。

描述

area: integrations severity: low source: roadmap wave: 4

Deferred work · F-PR54-M10-followup · severity Low · cost ~2 h · recorded in docs/roadmap/risks-and-decisions.md:264

Summary

Phase 14.5 shipped docs/reference/webhook_schema.md but not its optional third sub-task: a SUPPORTED_EVENTS frozenset as the single source of webhook event names, plus tools/check_webhook_event_vocabulary.py --strict. The eight-event table (EN + TR) is held to forgelm/webhook.py by review alone.

Condition or budget

None (optional).

State today (re-checked 2026-10-09)

forgelm/webhook.py has no SUPPORTED_EVENTS, and the guard does not exist; check_audit_event_catalog.py checks the names only against the audit-event catalog.

Related

#671 (CR-A17a-029) asks the catalog guard to check webhook event literals separately — it overlaps the guard half only.

Acceptance criteria

  • SUPPORTED_EVENTS is the single source, and a --strict guard fails when webhook_schema.md (EN or TR) and the emission sites disagree.
  • The row is removed from the deferral table and the CHANGELOG names its ID (the table's removal contract).

Recorded in docs/roadmap/risks-and-decisions.md (read at f94595f) and re-checked against the code on 2026-10-09. The row leaves that table only when the fix is on main, the CHANGELOG names its ID and any promised guard exists.

主要语言
Python
星标
9
派生
1
平均合并
8 小时 36 分钟
30 天内合并 PR
49

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

HodeTech/ForgeLM 的其他 Issue

查看 HodeTech/ForgeLM 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。