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

The help pages never say "pause", so organizers looking for it miss Close or reopen a signup

未关闭 适合新手
#653 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
typescript
领域
documentation

调研方向

从src/help/articles.ts中的“关闭或重新开放注册”条目开始,然后阅读docs/writing-help.md以及src/help/articles.test.tsx中的相关检查。更新摘要、描述和第一段,使其提到暂停,同时保持标题和按钮文案不变;在Unreleased › Changed下添加一行changelog。完成标准:帮助摘要和meta description包含“Pause”,文章提到暂停注册,并且文章测试通过。

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

描述

enhancement pipeline:proposed pipeline:ux

Needs your OK: this changes the summary and search description of the help page "Close or reopen a signup". Swap pipeline:proposed for pipeline:ready to have it built.

What happens

  • The help pages have no search. An organizer finds a page by its title and its one-line summary on /help.
  • "Close or reopen a signup" is the page for stopping sign-ups for a while. Its summary in src/help/articles.ts is "Stop anyone new signing up, and let people sign up again at the same link when you're ready."
  • "Pause" isn't anywhere on it: not in its title, summary, description or text, and not anywhere else in src/help.
  • A tester looking for it missed it. In the UX walkthrough on #610, a tester wanting to pause sign-ups searched the page for "pause" and "stop sign" and found nothing. They found the page only by reading every title.

Fix, in outline

  • Summary: for example, "Pause or stop sign-ups, and let people sign up again at the same link when you're ready."
  • Description, which search results and link previews show: for example, "Pause or close your signup so nobody new can sign up, and everyone already signed up keeps their spot. Reopen it later, at the same link." (137 characters.)
  • First paragraph of the article: add pausing to when you'd close it. For example: "…when you have enough people, when it's too late to sign up, or to pause sign-ups for a while."

Watch for

  • docs/writing-help.md: a "sign-up" is what someone does, and a "signup" is the page. src/help/articles.test.tsx checks the description's length (110 to 160 characters) and the style rules.
  • The title stays, so the slug and every link to the page stay the same.
  • The button is still Close signup. The page mustn't suggest there's a Pause button.
  • CHANGELOG: add a line under Unreleased › Changed.

Choices this makes

  • "Pause" goes in the summary, description and first paragraph, not the title. The title names the task by its button, as the other help pages do.
  • The wording above, which the owner can edit here first.

Done when

  • /help shows the new summary, and the page's meta description includes "Pause".
  • The first paragraph mentions pausing sign-ups.
  • articles.test.tsx passes.
  • pnpm lint && pnpm typecheck && pnpm knip && pnpm test pass.

From the UX walkthrough comment on #610 (https://github.com/richshaw/OpenSignup/pull/610#issuecomment-6402399737). Checked against src/help on main at 1d4ff3a. https://claude.ai/code/session_01LrYa57fvbqWjZj89iH975K

主要语言
TypeScript
星标
19
派生
4
平均合并
20 小时 9 分钟
30 天内合并 PR
156

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

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

richshaw/OpenSignup 的其他 Issue

查看 richshaw/OpenSignup 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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