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

Document maxComponents on component groups

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

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

評価

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

調査の方向性

content/4.api/ 内の既存の allowedComponents ページの隣から始め、執筆前に api-components-bundle のプルリクエスト 467 を読んで、実際のカウントルールと 422 の動作を確認してください。Issue の項目をすべて扱います。null というデフォルト値、上限にカウントされるもの、拒否される作成と移動、上限の引き下げ、componentPositions のチェックです。各項目が文書化され、group('header', allow: [...], max: 1) のフィクスチャ例が bundle と一致し、アップグレード手順が記載されていれば完了です。

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

説明

The bundle adds a maximum number of components per component group: https://github.com/components-web-app/api-components-bundle/pull/467 (issue https://github.com/components-web-app/api-components-bundle/issues/464; module half https://github.com/components-web-app/cwa-nuxt-module/issues/398).

To document (API, content/4.api/, next to allowedComponents):

  • maxComponents on ComponentGroup: null (default) is unlimited, otherwise a positive integer. Read and written with allowedComponents.
  • What counts: the positions the group lists. A dynamic page data position counts as one, a published component with its draft counts once, and a position hidden by allowedComponents does not count.
  • Creating a position in a full group, moving one into it, or creating a component with a position inside a full group is refused with a 422 naming the limit. Moving within the group is always allowed.
  • Lowering the limit below what a group holds deletes nothing. The group takes no more until it is under the limit.
  • A position written inside a component (componentPositions on a component POST) is now also checked against allowedComponents and #[ExplicitAllowOnly].
  • Fixtures: ->group('header', allow: [...], max: 1) on layout, page and component builders; generate-fixtures writes it.
  • Upgrade step: new max_components column on component_group; generate and run a migration.

When the module half lands, the module docs should cover the :max-components prop on <CwaComponentGroup>.

主要言語
Vue
スター
0
フォーク
0
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

components-web-app/docs のほかの issue

components-web-app/docs の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

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

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