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 Google Phần 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 trong các chuỗi tài liệu – Tài liệu Sympy
- Thời lượng dự án:
- Thời lượng tiêu chuẩn (3 tháng)
Mô tả dự án
Tóm tắt :
Trạng thái hiện tại của Tài liệu về Sympy và tác phẩm trước đây :
Công việc 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 một hướng dẫn quy tắc cho các chuỗi tài liệu SymPy. Bạn có thể xem hướng dẫn này tại SymPy Document Style Guide.
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ủ nhất quán các nguyên tắc của hướng dẫn quy tắc mới
Ngoài ra, 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 mới.
Công việc được đề xuất :
Hầu hết các chuỗi tài liệu trong SymPy vẫn không tuân theo hướng dẫn văn phong 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 toàn 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 chuyên gia 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 xuyên suốt 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 chỉ 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 vấn đề không thống nhất khác như việc 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 đến các tham số bằng cách thêm các ví dụ khác và bổ sung phần tham số.
Hãy tiếp tục thêm các ví dụ phức tạp vào phần lỗi khó khăn và lỗi.
Đóng góp: – #17887 : Giải quyết 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 vào một số hàm của mô-đun con Đặc biệt do L chỉnh sửa. Cố gắng làm theo hướng dẫn phong cách mới nhất và làm người mẫu cho các chuỗi tài liệu trong tương lai.
Đây là liên kết đến PR 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ột 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.
- Hãy tìm hiểu các kỹ thuật và kỹ năng hữu ích trong quá trình 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 và đặt kỳ vọng cho cả hai bên.
- 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 các mô-đun để làm cho 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(ngày 14 tháng 9 năm 2020 – ngày 30 tháng 11 năm 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 học phần hoặc học phần con mỗi tuần trở lên.
Đối với tất cả những học phần này, mục tiêu chính của tôi là bổ sung các phần còn thiếu và điều chỉnh cấu trúc chuỗi tài liệu để tuân theo hướng dẫn quy tắc mới nhất. Quy trình này sẽ thể hiện các kết quả thu được khi bạn chuyển các giá trị khác nhau 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 Lỗi và cạm bẫy.
Tuần 1 ( 14/9 – 21/9) : Nội dung chính
Tuần 2 (22/9 – 29/9)
Tuần 3 (30 tháng 9 – 6 tháng 10) : Hàm
Tuần 4 (ngày 7 tháng 10 – ngày 14 tháng 10) : Đơn giản hóa, Crypto
Tuần 5 (15/10 – 21/10) : Diophantine
Tuần 6 (22 tháng 10 - 29 tháng 10):Holonomic :Operations con
Tuần 7 (30 tháng 10 - 7 tháng 11) : Mô-đun tích phân(integrals.integrals), Tính tích phân bằng hàm G Meijer
Tuần 8 (8 tháng 11 – 15 tháng 11) : Vật lý, Hàm ở cuối Mô-đun danh mục, Mô-đun tạo mã, Mô-đun con đặc biệt
Tuần 9 (16 tháng 11 – 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ừ ngày 24/11 đến ngày 30/11)
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 của 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 gợi ý của người cố vấn, tôi sẽ tập trung vào việc cập nhật các học phần đó trước tiên để dễ cập nhật hơn, sau đó chuyển sang những học phần phức tạp.
Vì sao tôi là người phù hợp với 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 cũng thông 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à có những đó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 đã quen với việc chạy các bài kiểm thử và xây dựng tài liệu mỗi lần trước khi áp dụng các thay đổi vì đ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à rất mong được đóng góp.