এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- SymPy
- কৌশলী লেখক:
- সৌমি7
- প্রকল্পের নাম:
- ডকস্ট্রিং জুড়ে ধারাবাহিকতা - সিম্পি ডকুমেন্টেশন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বিমূর্ত:
সিম্পি ডকুমেন্টেশন এবং পূর্ববর্তী কাজের বর্তমান অবস্থা:
SymPy এর জন্য একটি অফিসিয়াল স্টাইল গাইড তৈরির কাজ সম্পূর্ণ হয়েছে।
লরেন গ্ল্যাটলির GSoD প্রকল্প SymPy ডকস্ট্রিং-এর জন্য একটি স্টাইল গাইড তৈরি করেছে, যা SymPy ডকুমেন্টেশন স্টাইল গাইডে পাওয়া যাবে।
বিশেষ সাবমডিউল এবং solvers.py ফাইলের ডকস্ট্রিংগুলি নতুন স্টাইল গাইডের নির্দেশিকাগুলি ধারাবাহিকভাবে অনুসরণ করার জন্য সম্পাদনা করা হয়েছিল
কোডবেস জুড়ে অন্যান্য সমস্ত ডকস্ট্রিংগুলি এখনও নতুন শৈলী নির্দেশিকা মেনে চলার জন্য সম্পাদনা করা বাকি ছিল।
প্রস্তাবিত কাজ:
SymPy-এর বেশিরভাগ ডকস্ট্রিং এখনও সর্বশেষ শৈলী নির্দেশিকা অনুসরণ করে না। এই প্রজেক্টের লক্ষ্য হবে এই নির্দেশিকা মেনে চলার জন্য SymPy জুড়ে ডকস্ট্রিং আপডেট করা।
আমি পরামর্শদাতাদের সাথে প্রকল্পটি নিয়ে আলোচনা করেছি। এখানে আলোচনার একটি লিঙ্ক।
সিদ্ধান্ত নেওয়া হয়েছিল যে লেটেস্ট স্টাইল গাইড মেনে চলার জন্য সিম্পির কোডবেস জুড়ে ডকস্ট্রিংগুলি সম্পাদনা করা একটি বড় কাজ এবং প্রকল্পটি এটির মধ্যেই সীমাবদ্ধ হওয়া উচিত।
প্রজেক্টে আমার কাজটি বিদ্যমান ডকস্ট্রিংগুলি আপডেট করার জন্য নতুন নির্দেশিকা বাস্তবায়নের সাথে জড়িত থাকবে, অন্যান্য অসঙ্গতি যেমন ভাষার ব্যবহার বা শর্তাদি সংগ্রহ ও সমাধান করার সময়।
বিদ্যমান উপধারার ক্রম পরিবর্তন বা সিদ্ধান্ত নেওয়া যেতে পারে পরে বা একটি পৃথক কাজ হিসাবে।
পরামিতি বিভাগের সাথে আরও উদাহরণ যোগ করে যখন বিভিন্ন মান প্যারামিটারে পাস করা হয় তখন ফলাফলের পার্থক্য প্রদর্শন করা।
গটচাস এবং পিটফল বিভাগে কঠিন উদাহরণ যোগ করতে থাকুন।
অবদান: - #17887 : ইস্যু #17887 এ কাজ করেছে: বিশেষ সাবমডিউলে অনুপস্থিত ডকস্ট্রিং বিভাগগুলি যোগ করুন। আমি স্পেশাল সাবমডিউলের কিছু ফাংশনে অনুপস্থিত পরামিতি এবং উদাহরণ বিভাগ যোগ করেছি যা L. Glattly দ্বারা সম্পাদিত সর্বশেষ শৈলী নির্দেশিকা অনুসরণ করতে এবং ভবিষ্যতের ডকস্ট্রিংগুলির জন্য একটি মডেল হিসাবে কাজ করে।
এখানে আমার মার্জড পিআরের লিঙ্ক রয়েছে: https://github.com/sympy/sympy/pull/19334
- #19591 : ইস্যু #19591 ডকুমেন্টেশন স্টাইল গাইড ট্র্যাক করে। আমি core.sympify docstring সম্পাদনা করতে একটি PR যোগ করেছি সর্বশেষ শৈলী নির্দেশিকা মেনে চলার জন্য। আমি বিভিন্ন পরামিতি ব্যবহারের উপর কাঠামোগত ব্যাখ্যা এবং উদাহরণ যোগ করেছি।
এখানে PR এর একটি লিঙ্ক রয়েছে: https://github.com/sympy/sympy/pull/19613
প্রকল্পের লক্ষ্য
17 আগস্টের আগে টাইমলাইন:
- প্রতিষ্ঠানে অবদান রাখা চালিয়ে যান।
- ব্যবহারকারী ডকুমেন্টেশন এবং sympy এর বর্তমান সংস্করণের সাথে আরও পরিচিত হন।
- কৌশল এবং দক্ষতা শিখুন যা প্রকল্প বাস্তবায়নের সময় সহায়ক হবে।
সম্প্রদায় বন্ধন : (আগস্ট 17 - সেপ্টেম্বর 13, 2020)
- একটি যোগাযোগ চ্যানেল এবং সময় সেট আপ করুন (সময়ের পার্থক্যের কারণে)।
- আমার লক্ষ্য পরিমার্জন এবং উভয় পক্ষের প্রত্যাশা সেট.
- মডিউল আপডেট করা হবে যে ক্রম আলোচনা.
- মডিউলগুলিকে সর্বশেষ ডকস্ট্রিং শৈলী নির্দেশিকা মেনে চলার জন্য সম্পাদনার ক্রম চূড়ান্ত করুন৷
ডকুমেন্টেশন সময়কাল (সেপ্টেম্বর 14, 2020 - নভেম্বর 30, 2020):
প্রতি সপ্তাহে অর্জন করতে লক্ষ্য নির্ধারণ করুন, প্রতি সপ্তাহে বা তার বেশি একটি মডিউল বা সাবমডিউলের ডকস্ট্রিং আপডেট করা পছন্দ করে।
এই সমস্ত মডিউলগুলির জন্য, আমার প্রাথমিক লক্ষ্য হবে অনুপস্থিত বিভাগগুলি যুক্ত করা এবং সর্বশেষ শৈলী নির্দেশিকা অনুসরণ করার জন্য ডকস্ট্রিংগুলিকে পুনর্গঠন করা। এতে বিভিন্ন মান প্যারামিটারে পাস করার সময় প্রাপ্ত বিভিন্ন ফলাফল প্রদর্শন করা অন্তর্ভুক্ত থাকবে। সমস্ত চতুর আউটপুট Gotchas এবং Pitfalls বিভাগে যোগ করা হবে।
সপ্তাহ 1 ( সেপ্টেম্বর 14 - সেপ্টেম্বর 21): কোর
সপ্তাহ 2 (সেপ্টেম্বর 22 - সেপ্টেম্বর 29): কার্যাবলী: সাবমডিউল কম্বিনেটরিয়াল
সপ্তাহ 3 (30 সেপ্টেম্বর - 6 অক্টোবর): কার্যাবলী
সপ্তাহ 4 (7ই অক্টোবর - 14ই অক্টোবর): সরলীকরণ, ক্রিপ্টো
সপ্তাহ 5 (15 অক্টোবর - 21 শে অক্টোবর): ডায়োফ্যান্টাইন
সপ্তাহ 6 (22শে অক্টোবর - 29শে অক্টোবর):হলোনোমিক: অপারেশন সাবমডিউল
সপ্তাহ 7 (30 শে অক্টোবর - 7ই নভেম্বর): ইন্টিগ্রালস মডিউল (ইনটিগ্রালস. ইন্টিগ্রালস), মেইজার জি-ফাংশন ব্যবহার করে ইন্টিগ্রাল কম্পিউটিং
সপ্তাহ 8 (8ই নভেম্বর - 15ই নভেম্বর): পদার্থবিদ্যা, ক্যাটাগরি মডিউল শেষে ফাংশন, কোড জেনারেশন মডিউল, সাবমডিউল বিশেষ
সপ্তাহ 9 (16ই নভেম্বর - 23 নভেম্বর): পদার্থবিদ্যা, ক্যাটাগরি মডিউলের শেষে ফাংশন, কোড জেনারেশন মডিউল, সাবমডিউল স্পেশাল
সপ্তাহ 10 (24 শে নভেম্বর - 30 নভেম্বর): গোটচাস এবং পিটফল বিভাগ
30 নভেম্বর - 5 ডিসেম্বর, 2020 18:00 UTC এ: চূড়ান্ত প্রকল্প জমা এবং প্রতিবেদন লেখা
ডিসেম্বর 3 - 10, 2020 at 18:00 UTC : প্রকল্পের সাফল্য এবং পরামর্শদাতাদের সাথে কাজ করার অভিজ্ঞতা জমা দেওয়া
এখানে উল্লিখিত মডিউলগুলির ক্রম পরামর্শদাতাদের সাথে আরও আলোচনার পরে পরিবর্তন করা যেতে পারে।
পরামর্শদাতাদের পরামর্শ অনুসারে, আমি প্রথমে সেই মডিউলগুলিকে আপডেট করার দিকে মনোনিবেশ করব যেগুলি আপডেট করা সহজ, তারপরে জটিলগুলির দিকে এগিয়ে যাব।
কেন আমি এই প্রকল্পের জন্য সঠিক ব্যক্তি?
আমি নিজেকে এই প্রকল্পের জন্য সঠিক ব্যক্তি বলে বিশ্বাস করি কারণ কম্পিউটার বিজ্ঞানের সাথে প্রযুক্তিগত লেখার অতীত অভিজ্ঞতা রয়েছে এবং আমি গিট এবং গিথুবের সাথে পারদর্শী।
যেহেতু আমি sympy-এর সর্বশেষ স্টাইল গাইডে ডকুমেন্টেশন আপডেট করার জন্য PR জমা দিয়েছি যা সফলভাবে একত্রিত করা হয়েছে, আমি কর্মপ্রবাহের প্রতি আস্থাশীল এবং নিয়মিত অবদান রাখছি।
প্রাথমিকভাবে যখন আমি অবদান শুরু করি, আমি কিছু ত্রুটির সম্মুখীন হয়েছিলাম। আমি পরিশেষে পরীক্ষা চালানো এবং প্রতিবার পরিবর্তনগুলি করার আগে ডক্স তৈরি করতে অভ্যস্ত হয়েছি কারণ এটি খুবই গুরুত্বপূর্ণ।
আমি এই প্রকল্পে অবদান রাখতে খুব স্বাচ্ছন্দ্যবোধ করছি এবং এটির জন্য অপেক্ষা করছি।