Clarify commit suggestions

Đang mở
#39 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
git
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với phần được liên kết “Formatting and Naming Conventions” trong Collaborative Distributed Science Guide và xem lại hướng dẫn hiện tại của phần này về commit. Được coi là hoàn thành khi phần này giải thích rõ mục đích của các thông điệp commit, tính dễ đọc và việc hiểu công việc đã thực hiện, đồng thời liên kết đến các phương pháp tốt về commit có thể đọc được bằng máy và nhấn mạnh lý do các thay đổi được thực hiện.

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

Mô tả

design documentation help wanted question

The Formatting and Naming Conventions section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.

Ngôn ngữ chính
Python
Star
1
Fork
1
Merge trung bình
6 ngày 1 giờ
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

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.

Issue khác của Imageomics/Collaborative-distributed-science-guide

Tất cả issue của Imageomics/Collaborative-distributed-science-guide

Issue tương tự

Thêm issue về Python

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.