QuantEcon / QuantEcon/lecture-python-programming.fr

Review: writing_good_code.md

Đang mở Phù hợp với người mới
#63 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.

audit maintenance
Ngôn ngữ chính
Python
Star
0
Fork
1
Merge trung bình
41 phút
Pull request đã merge (30 ngày)
3

Mô tả

Part of #40 (Phase 1).

Native-speaker review of writing_good_code.md by @Honaminto.

French (read this) lectures/writing_good_code.md
English source lectures/writing_good_code.md

How to reply. Open a PR editing the French directly — one PR for this lecture, titled e.g. [writing_good_code] Corrections — or leave line comments / suggestion blocks on it. Priorities: meaning errors, wrong technical terms, inconsistent terminology, unnatural French (academic register), anything in code comments that looks wrong. Ignore spacing before : ; ! ?, errors in the English, and the translation: header. A wrong term that recurs belongs on the terminology issue, not here.

Done when a PR by @Honaminto touching this file is merged, or he states here that the lecture needs no change. Either outcome is recorded; nothing is ticked by hand.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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

Mở lectures/writing_good_code.md trong repository tiếng Pháp và so sánh với nguồn tiếng Anh tại đường dẫn được liên kết. Kiểm tra ý nghĩa, các thuật ngữ kỹ thuật, tính nhất quán về thuật ngữ, tiếng Pháp học thuật và các chú thích trong code, đồng thời tuân theo các nội dung loại trừ được nêu trong issue; hoàn tất khi một PR cho file này được merged hoặc reviewer xác nhận rằng không cần thay đổi nào.

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

Đánh giá

Công nghệ
python
Lĩnh vực
documentation, localization
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Sôi nổi
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
88/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.