[docs] Create documentation for Class constants coding style
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- php
調査の方向性
https://moodledev.io/general/development/policies/codingstyle にある Moodle のコーディングスタイルページから始め、特に issue でリンクされている Classes セクションと Constants セクションを確認してください。Classes の下に「クラス定数」という明確なタイトルの小見出しを追加し、宣言ルールを明示するとともに、既存の 2 つのセクション間の曖昧さを解消してください。完成時には、ページ上で意図したスタイルが明確に示されている必要があります。
索引モデルが issue の本文から書いたものです。
説明
What is the Moodle feature that needs documenting?
An explicit set of rules for how class constants need to be declared would complete the documentation. So far, it is implied in https://moodledev.io/general/development/policies/codingstyle#constants-1, but with how the document page is currently structured, people might think, that this (https://moodledev.io/general/development/policies/codingstyle#constants) is the way to go.
In conclusion, my request is a subchapter "Class constants" under https://moodledev.io/general/development/policies/codingstyle#classes-1 where the coding style for class constants are explicitly declared.
Is this documentation specific to a Moodle version?
Unsure (Default)
Are you able to provide a patch for this?
No (Default)
- 主要言語
- TypeScript
- スター
- 74
- フォーク
- 652
- 平均マージ
- 2日 50分
- マージ済み PR(30日)
- 12
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
moodle/devdocs のほかの issue
-
bug documentation help wanted needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
documentation enhancement help wanted needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
bug documentation help wanted needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
-
bug documentation good first issue needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
bug documentation help wanted needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
似ている issue
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
Mend: dependency security vulnerability untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100