Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- SymPy
- Người viết nội dung kỹ thuật:
- Soumi7
- Tên dự án:
- Tính nhất quán giữa các chuỗi tài liệu – Tài liệu về tính ổn định
- Thời lượng dự án:
- Thời gian tiêu chuẩn (3 tháng)
Mô tả dự án
Bản tóm tắt :
Trạng thái hiện tại của Tài liệu Sympy và công việc trước đó :
Quá trình tạo hướng dẫn quy tắc chính thức cho SymPy đã hoàn tất.
Dự án GSoD của Lauren Glattly đã tạo hướng dẫn về quy tắc cho các chuỗi tài liệu SymPy. Bạn có thể tìm thấy hướng dẫn này tại Hướng dẫn về quy tắc tài liệu của SymPy.
Các chuỗi tài liệu trong mô-đun con đặc biệt và tệp solvers.py được chỉnh sửa để tuân thủ các nguyên tắc của hướng dẫn quy tắc mới một cách nhất quán
Tất cả các chuỗi tài liệu khác trong cơ sở mã vẫn được chỉnh sửa để tuân thủ hướng dẫn quy tắc kiểu mới.
Công việc đề xuất :
Hầu hết các tài liệu trong SymPy vẫn không tuân theo hướng dẫn quy tắc mới nhất. Mục tiêu của dự án này là cập nhật các chuỗi tài liệu trên khắp SymPy để tuân thủ hướng dẫn này.
Tôi đã thảo luận về dự án này với các cố vấn. Dưới đây là đường liên kết đến cuộc thảo luận.
Chúng tôi quyết định rằng việc chỉnh sửa chuỗi tài liệu trong toàn bộ cơ sở mã của sympy để tuân thủ hướng dẫn quy tắc mới nhất là một nhiệm vụ lớn và dự án nên được giới hạn ở đó.
Công việc của tôi trong dự án này bao gồm việc triển khai hướng dẫn mới để cập nhật các chuỗi tài liệu hiện có, đồng thời thu thập và giải quyết những điểm không thống nhất khác như cách sử dụng ngôn ngữ hoặc thuật ngữ.
Thứ tự của các tiểu mục hiện có có thể được thay đổi hoặc quyết định sau hoặc dưới dạng một tác vụ riêng biệt.
Minh hoạ sự khác biệt về kết quả khi các giá trị khác nhau được chuyển vào các thông số bằng cách thêm các ví dụ khác và bổ sung phần thông số.
Hãy tiếp tục thêm các ví dụ phức tạp vào phần khó khăn và cạm bẫy.
Đóng góp: – #17887 : Đã khắc phục vấn đề #17887: Thêm các phần chuỗi tài liệu bị thiếu trong Mô-đun con đặc biệt. Tôi đã thêm phần Thông số và Ví dụ bị thiếu trong một số hàm của mô-đun con Đặc biệt do L chỉnh sửa. Làm theo hướng dẫn lập trình mới nhất và làm mẫu cho các chuỗi tài liệu trong tương lai.
Đây là liên kết với PR được hợp nhất của tôi : https://github.com/sympy/sympy/pull/19334
- #19591 : Vấn đề #19591 theo dõi hướng dẫn kiểu Tài liệu. Tôi thêm mục PR để chỉnh sửa chuỗi tài liệu core.sympify nhằm tuân thủ hướng dẫn quy tắc mới nhất. Tôi đã thêm nội dung giải thích có cấu trúc và ví dụ về cách sử dụng các thông số.
Đây là liên kết đến PR: https://github.com/sympy/sympy/pull/19613
Mục tiêu dự án
Lịch trình Trước ngày 17 tháng 8 :
- Tiếp tục đóng góp cho tổ chức.
- Trở nên quen thuộc hơn với tài liệu người dùng và phiên bản sympy hiện tại.
- Tìm hiểu các kỹ thuật và kỹ năng hữu ích khi triển khai dự án.
Gắn kết cộng đồng : (17/8 – 13/9/2020)
- Thiết lập kênh và thời gian liên lạc (do chênh lệch thời gian).
- Tinh chỉnh mục tiêu của tôi và đặt kỳ vọng cho cả hai phía.
- Thảo luận về thứ tự cập nhật các mô-đun.
- Hoàn tất thứ tự chỉnh sửa mô-đun để các mô-đun đó tuân thủ hướng dẫn về kiểu chuỗi tài liệu mới nhất.
Thời gian cung cấp tài liệu(14/9/2020 – 30/11/2020) :
Đặt mục tiêu cần đạt được mỗi tuần, tốt nhất là hoàn thành việc cập nhật các chuỗi tài liệu của một mô-đun hoặc mô-đun con mỗi tuần trở lên.
Đối với tất cả các học phần này, mục tiêu chính của tôi là thêm các phần còn thiếu và sắp xếp lại các chuỗi tài liệu để tuân theo hướng dẫn quy tắc mới nhất. Việc này sẽ minh hoạ các kết quả thu được khi chuyển nhiều giá trị vào các thông số. Tất cả các kết quả khó khăn sẽ được thêm vào phần khó khăn và cạm bẫy.
Tuần 1 ( 14/9 – 21/9) : Nội dung chính
Tuần 2 (22/9 – 29/9) : Hàm : Submodules Combinatorial
Tuần 3 (30/9 – 6/10) : Hàm
Tuần 4 (ngày 7 tháng 10 – ngày 14 tháng 10) : Rút gọn, Crypto
Tuần 5 (15/10 – 21/10) : Diophantine
Tuần 6 (22 tháng 10 - 29 tháng 10):Holmetric :Operations con
Tuần 7 (30 tháng 10 - 7 tháng 11) : Mô-đun tích phân(integrals.integrals), tích phân tính toán sử dụng các hàm G Meijer
Tuần 8 (8/11 – 15/11) : Vật lý, Hàm ở cuối các phần Mô-đun, Mô-đun tạo mã, Mô-đun con đặc biệt
Tuần 9 (từ ngày 16 tháng 11 đến ngày 23 tháng 11) : Vật lý, Hàm ở cuối Mô-đun hạng mục, Mô-đun tạo mã, Mô-đun con đặc biệt
Tuần 10 (từ 24/11 – 30/11) : Phần Kiến thức và cạm bẫy
Ngày 30 tháng 11 – ngày 5 tháng 12 năm 2020 lúc 18:00 (giờ UTC): Gửi dự án cuối cùng và viết báo cáo
Từ ngày 3 đến 10 tháng 12 năm 2020 lúc 18:00 (giờ UTC): Gửi thành công dự án và kinh nghiệm làm việc với các cố vấn
Bạn có thể thay đổi thứ tự của các học phần được đề cập ở đây sau khi thảo luận thêm với cố vấn.
Theo đề xuất của các cố vấn, tôi sẽ tập trung vào việc cập nhật những học phần dễ cập nhật hơn trước, sau đó mới chuyển sang những học phần phức tạp.
Tại sao tôi là người phù hợp cho dự án này?
Tôi tin rằng mình là người phù hợp cho dự án này vì tôi có kinh nghiệm viết kỹ thuật trong lĩnh vực Khoa học máy tính và tôi thành thạo git và github.
Vì tôi đã gửi PR để cập nhật tài liệu lên hướng dẫn quy tắc mới nhất trong sympy đã được hợp nhất thành công, tôi tự tin với quy trình làm việc và đóng góp thường xuyên.
Ban đầu khi bắt đầu đóng góp, tôi đã gặp một số lỗi. Cuối cùng, tôi cũng đã quen với việc chạy các chương trình kiểm thử và xây dựng tài liệu mỗi lần triển khai trước khi áp dụng các thay đổi vì đó là điều rất quan trọng.
Tôi rất thoải mái khi đóng góp cho dự án này và tôi rất mong được nhận huy hiệu của bạn.