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

Documentation format for benefits and checks

Đang mở
  • Có gì không ổn?
#566 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
52/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
java
Lĩnh vực
documentation

Hướng nghiên cứu

Start by reading the new-dmn-benefit and new-dmn-check skills and inspect existing DMN benefits and checks to see how Description fields, Text Annotation nodes, and Documentation Links are used. Manually create one reference benefit and check with the desired detail and formatting, then use them to guide drafts for the remaining items and update both skills with the documentation standards. Done means the reference examples and future creation guidance consistently reflect the agreed documentation format.

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

Mô tả

The library includes documentation embedded within the DMN (using provided DMN constructs for such purposes -- Description fields, Text Annotation nodes, and Documentation Links).

We should create a reference benefit and check (manually) that reflects the detail and formatting that we want to be included for all checks and then have the AI draft the same detail/formatting for every other benefit and check.

Also, we should update the new-dmn-benefit and new-dmn-check skills to reflect the documentation particulars so that future benefits/checks will respect the same standards.

Ngôn ngữ chính
Java
Star
16
Fork
5
Merge trung bình
14 giờ 34 phút
Pull request đã merge (30 ngày)
23

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có 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 CodeForPhilly/benefit-decision-toolkit

Tất cả issue của CodeForPhilly/benefit-decision-toolkit

Issue tương tự

Thêm issue về Java

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.