📚 Documentation: App class documentation is not up to date

オープン
#91 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
php
領域
documentation

調査の方向性

Compare README.md and Getting-Starting-Guide.md with the current App class behavior, focusing on the documented hook types and init parameters. Update both documents so they describe the current API accurately, then verify that the outdated three-hook and parameter descriptions are gone.

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

説明

💭 Description

Both the README.md file and the Getting-Starting-Guide.md file suggests that there are 3 types of hooks, and that the parameters for the init hook for example are a callback function, a resources array, and a group.

However, this has not been the case for the past 2 years.

Documentation should be updated.

👀 Have you spent some time to check if this issue has been raised before?
  • I checked and didn't find similar issue
🏢 Have you read the Code of Conduct?
主要言語
PHP
スター
297
フォーク
34
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

utopia-php/http のほかの issue

utopia-php/http の issue をすべて見る

似ている issue

PHP の issue をもっと見る

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

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