mapbox / mapbox/node-cpp-skel

Improving code formatting docs with additional efficiency recommendations

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

help wanted
Ngôn ngữ chính
C++
Star
74
Fork
9
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

node-cpp-skel has support for:

  • a .clang-format style file that provides formatting rules (which can be modified/customized)
  • make format an easy command to run to consistently format all the code (and ensure a consistent version of clang-format is available)
  • a travis job that runs a check to catch when you've forgotten to format your code and in contains incorrectly formatted code (uses same clang-format version as is used locally by make format)

We can improve by adding docs/recommendations for developers for how to:

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

Tìm tài liệu đề cập đến .clang-format, make format và bước kiểm tra định dạng của Travis. Xem tài liệu tham khảo về pre-commit hook và video về tích hợp trình soạn thảo được liên kết, sau đó bổ sung các khuyến nghị cho cả hai workflow. Công việc được xem là hoàn tất khi các nhà phát triển có thể tìm thấy hướng dẫn có thể áp dụng để thiết lập hook định dạng và cấu hình các trình soạn thảo phổ biến sử dụng clang-format do Mason cài đặt.

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
Lĩnh vực
documentation, tooling
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
Nửa 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.