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

[docs] Create documentation for Class constants coding style

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

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

評価

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

調査の方向性

https://moodledev.io/general/development/policies/codingstyle にある Moodle のコーディングスタイルページから始め、特に issue でリンクされている Classes セクションと Constants セクションを確認してください。Classes の下に「クラス定数」という明確なタイトルの小見出しを追加し、宣言ルールを明示するとともに、既存の 2 つのセクション間の曖昧さを解消してください。完成時には、ページ上で意図したスタイルが明確に示されている必要があります。

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

説明

documentation enhancement help wanted
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

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

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

はじめの一歩

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

moodle/devdocs のほかの issue

moodle/devdocs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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