Define a naming style for prompt block titles

オープン 初心者向け
  • 何か問題がありますか？
#3,185 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
javascript
領域
documentation

調査の方向性

standards/page-structure.md の「Prompt examples」セクションから始め、提案された検索 grep -rn 'prompt title=".* prompt"' sources に従って、名前を変更するタイトルを見つけます。提案されたタイトルスタイルのルールを追加し、該当するタイトルを更新します。ガイドラインが文書化され、既存のタイトルがそれに従っていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

t-docs

Prompt block titles (```prompt title="…") follow two styles:

  • All 14 Academy titles end in "prompt", for example "Draft user README prompt", "Recommend pricing prompt", "Change input URL prompt" and "Log items prompt" (in sources/academy/webscraping/scraping_with_ai/). apify/apify-docs#3164 adds 4 more.
  • Platform titles don't, for example "Find a Google Maps Actor" and "Run a saved task".

The card already has a Copy prompt button, so the suffix repeats what the card shows. The "Prompt examples" section in standards/page-structure.md, added in apify/apify-docs#3164, says to set a title but not how to write one.

Proposal:

  1. Add a rule to standards/page-structure.md#prompt-examples, for example: "Write the title as a short imperative phrase in sentence case that says what the prompt does. Don't end it with 'prompt'."
  2. Rename the existing titles that end in "prompt" (grep -rn 'prompt title=".* prompt"' sources).
主要言語
JavaScript
スター
82
フォーク
240
平均マージ
3日 17時間
マージ済み PR（30日）
73

環境構築

はじめの一歩

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

apify/apify-docs のほかの issue

apify/apify-docs の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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