Improving code formatting docs with additional efficiency recommendations
Đang mở
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-formatstyle file that provides formatting rules (which can be modified/customized) make formatan 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:
- add a git commit hook to ensure code is formatted (before pushing) - refs http://www.duskborn.com/git-pre-commit-clang-format-hook/
- integrate the mason installed clang-format with common text editors such that formatting happens during coding (like seen in https://youtu.be/uZI_Qla4pNA?t=1904)
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- 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