Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Suggestion: Document best practices and references for contributors

Đang mở
  • Có gì không ổn?
#3,850 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
32/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Read the linked discussion on pull request #3849 and review the README.rst placement question. Ask maintainers to settle whether the guidance belongs in the README or a project wiki, then document the listed references and dictionary-entry advice; done means the location and content are agreed and published.

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

Mô tả

enhancement

It would be beneficial to create a list of suggestions and best practices for contributors, drawing from advice provided by maintainers in previous issues and pull requests. The recommendations could include:

  • Use the OED (Oxford English Dictionary) as the primary reference for English word spellings.
  • Use SCOWL and Friends as the open-source English dictionary of reference for spell checkers. Let it have the last word.
  • Utilize the Google Ngram Viewer to check the frequency and commonality of terms or proposed corrections.
  • When adding dictionary entries, always include all verbal forms (e.g., present, past, participle) and both singular and plural nouns.

A point for discussion: Should this advice be added to the main README.rst, understanding that it could clutter the file, or should we create and use a project wiki page to keep the README concise?

Feedback and preferences from maintainers and contributors on the above structure would be appreciated.

Based on https://github.com/codespell-project/codespell/pull/3849#discussion_r2628371422.

Ngôn ngữ chính
Python
Star
2.4k
Fork
531
Merge trung bình
15 giờ 55 phút
Pull request đã merge (30 ngày)
17

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Không có Dockerfile hay tệp Docker Compose
  • Không có mẫu pull request
  • Không có 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.

Issue khác của codespell-project/codespell

Tất cả issue của codespell-project/codespell

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.