Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[docs] Create documentation for Class constants coding style

Đang mở
#425 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
php
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với trang quy tắc định dạng mã của Moodle tại https://moodledev.io/general/development/policies/codingstyle, đặc biệt là các phần Classes và Constants được liên kết trong issue. Thêm một tiểu chương có tiêu đề rõ ràng “Hằng số lớp” bên dưới Classes, nêu rõ các quy tắc khai báo và giải quyết sự mơ hồ giữa hai phần hiện có; khi hoàn tất, trang phải thể hiện rõ phong cách dự kiến.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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)

Ngôn ngữ chính
TypeScript
Star
74
Fork
652
Merge trung bình
2 ngày 50 phút
Pull request đã merge (30 ngày)
12

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của moodle/devdocs

Tất cả issue của moodle/devdocs

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.