How do we want to document clang-tidy and clang-format config options?
Đang mở
Chưa có ai nhận issue này.
- 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ả
Would it be useful to add documentation in the config files about different clang-tidy options for example? Or would we rather document in a readme?
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
Bắt đầu bằng cách xác định các tệp cấu hình clang-tidy và clang-format cùng mọi tài liệu README trong kho lưu trữ. So sánh các vị trí hiện có để giải thích các tùy chọn cấu hình, sau đó làm rõ những tùy chọn nào cần được đề cập và liệu tài liệu nên nằm trong các tệp cấu hình hay README. Công việc được coi là hoàn tất khi dự án đã thống nhất vị trí đặt tài liệu và các tùy chọn liên quan được ghi lại tại đó.
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ó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 20/100