blog

CursorRules.orgに新しいカーソルルールを追加する

CursorRules.org に新しいカーソル ルールを追加して、ルールが有効かつ適切にフォーマットされていることを確認し、開発エクスペリエンスを向上させる方法を学習します。

CursorRules.orgに新しいカーソルルールを追加する

以下の手順に従って、CursorRules.orgに新しいカーソルルールを追加してください。

ステップ1: 新しいカーソルルールを追加する

  1. CursorRulesリポジトリを開く: CursorRules
  2. 対応するJSONCファイル /data/json/[locale]/rules/{category}.jsonc を開く
  3. ファイルに新しいカーソルルールを挿入する
  4. {category}.jsonc ファイルが存在しない場合は、以下の手順に従ってください:
    1. /data/json/[locale]/rules/category.jsonc に新しいカテゴリを追加する
    2. /data/json/[locale]/rules/example.jsonc を新しい場所 /data/json/[locale]/rules/{category}.jsonc にコピーする
    3. この新しく作成したファイルにカーソルルールを追加する

ステップ2: 変更を提出してプルリクエストを作成する

PRチェックリスト

PRを提出する前に、以下の項目を確認してください:

  • [ ] 名前: 追加するルールを説明する短いタイトルを提供する
  • [ ] 説明: 追加されたルールとそのカテゴリを明確に説明する
  • [ ] URL: ルールのソースリンクを提供する(利用可能な場合)
  • [ ] データの並べ替え: 変更されたJSONファイル内のすべてのデータがアルファベット順に並んでいることを確認する
  • [ ] ルールの検証: ルールが有効であり、主要なエディタで動作することを確認する
  • [ ] 関連性: カーソル操作に関連するルールのみを含めることを確認する

重要な注意点:

  1. すべてのエントリがアルファベット順に並んでいることを確認してください。これらはこの順序でウェブサイトに表示されます
  2. ルールは検証済みであり、主要なエディタで動作する必要があります
  3. カーソル操作に関係のないルールを提出しないでください