RFC: New repository for code examples in Documentation
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- documentation
Hướng nghiên cứu
Issue không nêu tên tệp, bài kiểm thử hay điểm vào nào; hãy bắt đầu bằng việc xem xét tài liệu hiện có và các đoạn mã trong đó. Công việc được xem là hoàn tất khi tạo một repository riêng chứa các ví dụ có thể chạy cho những lớp chính và thêm các tham chiếu trực tiếp từ tài liệu đến những ví dụ đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Most of the documents bring code snippets. Considering that full file examples would take a lot of space in the documents and make them complex, a new repository with running examples per main classes would be a useful complement to them. The documentation could make direct reference to them. The users can clone the repository and run the examples in his/her local environment to have fully running demos of the code cited in the docs.
- Ngôn ngữ chính
- MDX
- Star
- 23
- Fork
- 29
- Merge trung bình
- 3 ngày 16 giờ
- Pull request đã merge (30 ngày)
- 1
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của phalcon/documentation
-
Document DataMapper\ORMCó thể làm lại được @niden đã nhận 607 ngày trước và không có pull request nào đang mở. Đang mởdocumentation enhancement
phalcon/documentation#247 · 1 người được giao ·
-
Document DataMapper\MapperCó thể làm lại được @niden đã nhận 607 ngày trước và không có pull request nào đang mở. Đang mởdocumentation enhancement
phalcon/documentation#246 · 1 người được giao ·
-
Document DataMapper\CliCó thể làm lại được @niden đã nhận 607 ngày trước và không có pull request nào đang mở. Đang mởdocumentation enhancement
phalcon/documentation#245 · 1 người được giao ·
-
Document DataMapper\InfoCó thể làm lại được @niden đã nhận 607 ngày trước và không có pull request nào đang mở. Đang mởdocumentation enhancement
phalcon/documentation#244 · 1 người được giao ·
-
Document DataMapper\TableCó thể làm lại được @niden đã nhận 607 ngày trước và không có pull request nào đang mở. Đang mởdocumentation enhancement
phalcon/documentation#243 · 1 người được giao ·
Tất cả issue của phalcon/documentation
Issue tương tự
-
Readme 中 Releases 链接指向的是完整版字库Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
-
untriaged
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
ubuntu/ubuntu-project-docs#850 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
feedback simulation workshop
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
githubnext/gh-aw-workshop#4755 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
fix
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
idean3885/claude-ops-agent#728 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 67/100