mapbox / mapbox/cpp

Add narrative documentation on how we do binary deployment

Đang mở
#48 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.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
110
Fork
17
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Now that our https://github.com/mapbox/cpp/blob/master/glossary.md is fairly complete, it is a good time to add new, narrative docs that tie together glossary terms.

In particular, there is a need for a binary deployment doc that explains the flow from C++ source code -> node addons -> binary distribution.

Here is a first stab at listing things to cover in this doc:

We use mason for:

  • distributing pre-compiled (aka binary) static libraries for C/C++ code. And in rare cases shared libraries.
  • distributing source code of header-only libraries
  • distributing binaries of executables (aka command line programs).

We use node-pre-gyp for:

  • Binary deployment of node C++ addons
  • When those node C++ addons have external C/C++ dependencies we use mason to pull packages for them
  • Soon we'll open source https://github.com/mapbox/mason-js which will make these more seamless (no need for the mason bash scripts)

TODO:

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.

Hướng nghiên cứu

Bắt đầu với glossary.md và các trang wiki node-pre-gyp hiện có về External-libraries và FAQ. Theo dõi quy trình được ghi chép từ mã nguồn C++ qua node addons đến việc phân phối binary, bao quát mason và node-pre-gyp, sau đó tích hợp tài liệu cũ liên quan vào repository này cùng với các liên kết đến bảng thuật ngữ và tài liệu liên quan.

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

Đánh giá

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

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.