Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
#653 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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の行を追加します。ヘルプの概要とメタ説明に「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分
マージ済み PR(30日)
156

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

richshaw/OpenSignup のほかの issue

richshaw/OpenSignup の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。