extern guidelines

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

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ài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
node.js
Lĩnh vực
documentation

Hướng nghiên cứu

Xem xét các định nghĩa extern hiện có của hxnodejs và so sánh cách module packages, @:jsRequire, event enums, structure typing, overloads, đối số tùy chọn, EitherType và DynamicAccess hiện được biểu diễn. Hướng dẫn được hoàn tất khi các quy ước này và mọi quy tắc bổ sung cần thiết được ghi lại rõ ràng cho các module Node.js của bên thứ ba.

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

Mô tả

we need to make a guideline document that describes how to write externs for third-party node.js modules so they fit nicely in our official structure.

  • module classes/packages, @:jsRequire
  • event enums
  • structure typing
  • overloading and optional args
  • usage of EitherType and DynamicAccess (when it's finally merged)
  • anything else?
Ngôn ngữ chính
Haxe
Star
177
Fork
58
Không có pull request nào được merge trong 30 ngày

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

  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 HaxeFoundation/hxnodejs

Tất cả issue của HaxeFoundation/hxnodejs

Issue tương tự

Thêm issue về Documentation

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.