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

Update documentation to better explain `@wip` tag

Đang mở
  • Có gì không ổn?
#182 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với docs/source/development.rst và README.rst, sau đó đọc gherkinize.py để hiểu cách dữ liệu kiểm thử từ cel-spec trở thành cây thư mục của thư mục features và nhận các thẻ @wip. Cập nhật phần giải thích về Development Tools và thêm một liên kết đến README; trang feature-list hoàn chỉnh đã được đánh dấu là hoàn tất bởi #191. Công việc được coi là hoàn tất khi cả hai đường dẫn tài liệu đều giải thích rõ luồng và liên kết chính xác.

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

Mô tả

documentation enhancement tracking

Three related changes to the documentation.

  • Update the Development Tools section (docs/source/development.rst) to include an explanation of the @wip tag, and how the test data flows from cel-spec to the features directory tree with tags injected by the gherkinize.py tool.

  • Add a link to this to the README.rst to provide a clear path to show how @wip tags are injected into the tests.

  • Add a page with the complete list of features, showing ✅ and ❌ for the features supported and the features marked @wip. (It's not clear precisely how to do this. It might be an useful secondary output from the gherkinize.py tool.) Completed by #191

Ngôn ngữ chính
Python
Star
174
Fork
41
Không có pull request nào được merge trong 30 ngày

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

  • Có Dockerfile hoặc tệp Docker Compose
  • Không 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 cloud-custodian/cel-python

Tất cả issue của cloud-custodian/cel-python

Issue tương tự

Thêm issue về Python

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.