moodle / moodle/devdocs

[docs] Create documentation for Class constants coding style

Open
#425 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement help wanted
Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

Description

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)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Moodle coding style page at https://moodledev.io/general/development/policies/codingstyle, especially the Classes and Constants sections linked in the issue. Add a clearly titled “Class constants” subchapter under Classes, making the declaration rules explicit and resolving the ambiguity between the two existing sections; the page should plainly show the intended style when finished.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.