আপনার প্রকল্প প্রতিবেদন তৈরি করা হচ্ছে

বর্তমান পর্যায়:
ডক্স প্রোগ্রামের 2020 সিজন 15 মার্চ, 2021 এ শেষ হয়েছে। টাইমলাইন দেখুন।

এই পৃষ্ঠায় কারিগরি লেখকদের জন্য নির্দেশিকা রয়েছে যখন আপনি এই বছরের ডক্সের সিজনে আপনার কাজ শেষ করে ফেলেছেন তখন কীভাবে আপনার প্রকল্প প্রতিবেদন তৈরি করবেন।

আপনার প্রকল্প রিপোর্ট জমা দেওয়া

যখন প্রকল্প চূড়ান্তকরণের পর্যায়টি খোলে, আপনি প্রযুক্তিগত লেখক গাইডের প্রকল্প চূড়ান্তকরণ বিভাগে উপলব্ধ একটি ফর্ম পূরণ করে আপনার প্রকল্প প্রতিবেদন জমা দিতে সক্ষম হবেন।

প্রকল্প প্রতিবেদনে অন্তর্ভুক্ত করার জন্য তথ্য

এই বিভাগটি বর্ণনা করে যে ধরনের তথ্য আপনি আপনার প্রকল্প প্রতিবেদনে সরবরাহ করতে পারেন। প্রজেক্ট রিপোর্ট ফর্মে ফ্রি-টেক্সট ফিল্ডের পাশাপাশি একাধিক পছন্দের প্রশ্নও থাকবে।

আপনি যে কাজটি করেছেন তার বর্ণনার দিকে নির্দেশ করে একটি লিঙ্ক দিন।

লিঙ্কটি এমন একটি নথির দিকে নির্দেশ করা উচিত যেখানে সম্পন্ন কাজের একটি সংক্ষিপ্ত বিবরণ রয়েছে, ডকুমেন্টেশন যা ওপেন সোর্স প্রকল্পটি তার সংগ্রহস্থলে একত্রিত হয়েছে, প্রকল্পের বর্তমান অবস্থার একটি সারাংশ এবং চ্যালেঞ্জ এবং শিক্ষার একটি তালিকা।

লিঙ্কটি ওয়েবসাইটে প্রকাশিত ডক্স ফলাফলের মরসুমে প্রদর্শিত হবে। প্রকাশিত ফলাফলগুলি প্রোগ্রাম চলাকালীন আপনি যে কাজটি সম্পন্ন করেছেন তা প্রদর্শন করে। প্রকাশিত ফলাফলগুলি আপনার জীবনবৃত্তান্তের অংশ হিসাবে আপনার কাজকে আবার উল্লেখ করার জন্য একটি দুর্দান্ত উপায়।

আপনার পরামর্শদাতার সাথে আপনার লিঙ্কটি ভাগ করা উচিত এবং আপনার প্রকল্প প্রতিবেদন জমা দেওয়ার আগে একটি পর্যালোচনার জন্য জিজ্ঞাসা করা উচিত।

আপনার প্রকল্প রিপোর্টের জন্য প্রয়োজনীয়তা

নিম্নলিখিত প্রয়োজনীয়তাগুলি বিবেচনায় নিন:

  • লিঙ্ক করা বিষয়বস্তু অবশ্যই ডক্সের সিজনে আপনি যে কাজটি সম্পন্ন করেছেন তা সনাক্ত করা সহজ করে তুলবে, অর্থাৎ, আপনি যে পরিবর্তনগুলি করেছেন বা আপনি যে নতুন ডকুমেন্টেশন লিখেছেন।
  • কাজ একটি স্থিতিশীল অবস্থানে হওয়া উচিত। আপনি জমা দেওয়ার পরে URL পরিবর্তন করতে পারবেন না।
  • অন্য কেউ আপনার কাজের উপর ভিত্তি করে লিঙ্কের লক্ষ্যে (বা থেকে রেফারেন্স) বিষয়বস্তু ব্যবহার করতে সক্ষম হওয়া উচিত।

    • আপনার কাজ 100% সম্পূর্ণ হলে, অন্য লোকেদের এটি ব্যবহার করতে সক্ষম হওয়া উচিত।
    • যদি আপনার কাজ 100% সম্পূর্ণ না হয়, তবে কী করা বাকি আছে তা পরিষ্কার হওয়া উচিত।

আপনার কাজ বর্ণনা কিভাবে ভাল উদাহরণ

আপনাকে এই জিনিসগুলির সবগুলি (বা যে কোনও) করতে হবে না, তবে এইগুলি কিছু উপায় যা আপনি প্রয়োজনীয়তাগুলি পূরণ করতে পারেন:

  • একটি ব্লগ পোস্ট বা ওয়েব পৃষ্ঠা বা সর্বজনীন GitHub সারাংশ তৈরি করুন যা আপনি যে কাজটি করেছেন এবং আপনার করা প্রতিশ্রুতি এবং আপনি যে সংগ্রহস্থলগুলিতে কাজ করেছেন তার সাথে লিঙ্ক করে। যদি এখনও প্রকল্পে কাজ করা বাকি থাকে, তাহলে সেই কাজের বিবরণ অন্তর্ভুক্ত করুন। আপনি হাইলাইট বা চ্যালেঞ্জিং টুকরা শেয়ার করতে পারেন.

    এটি সর্বোত্তম বিকল্প কারণ এটি আপনাকে সহজেই প্রচুর তথ্য অন্তর্ভুক্ত করতে দেয়। এটি ভাল কারণ এটি আপনার কাজটি স্পষ্টভাবে দেখায় এবং অন্যদের জন্য আপনার অবদান ব্যবহার করা এবং বুঝতে সহজ করে তোলে।

  • যদি GitHub ব্যবহার করে, এবং আপনার সমস্ত কাজ একটি একক পুল অনুরোধ দ্বারা আচ্ছাদিত হয়, আপনি সেই লিঙ্কটি ব্যবহার করতে পারেন।

    • নিশ্চিত করুন যে পুল অনুরোধের বিবরণ বিস্তারিত আছে।
    • নিশ্চিত করুন যে বিবরণ স্পষ্টভাবে নোট করে যে কাজটি ডক্সের সিজনের জন্য।
    • ডক্সের সিজন শেষ হওয়ার পরে যদি পুল অনুরোধের আরও কাজের প্রয়োজন হয়, তবে নিশ্চিত করুন যে ডক্সের শেষ সিজনটি এই সত্যটি নোট করে।
    • একটি প্রকল্প প্রতিবেদন প্রদানের এই পদ্ধতিতে পরিবর্তন লগ, প্রতিশ্রুতির একটি তালিকা এবং পর্যালোচনা মন্তব্যগুলি এক জায়গায় থাকার সুবিধা রয়েছে।
  • যদি আপনার GitHub সংগ্রহস্থলটি ডক্সের মরসুমের জন্য একক উদ্দেশ্য হয়, তাহলে আপনার কাজের বিবরণ সহ একটি README ফাইল যোগ করুন।

  • Google ড্রাইভে একটি সর্বজনীন ফোল্ডার তৈরি করুন এবং আপনার তৈরি করা সমস্ত প্যাচ অন্তর্ভুক্ত করুন৷

  • Google পত্রক দিয়ে একটি সর্বজনীন স্প্রেডশীট তৈরি করুন এবং আপনার সমস্ত প্রতিশ্রুতি তালিকাভুক্ত করুন৷

  • একটি পাবলিক ইস্যু ট্র্যাকারে একটি একক সমস্যার লিঙ্ক করুন, যাতে আপনার কাজের স্পষ্ট উল্লেখ রয়েছে এবং অন্য কিছু উপযুক্ত। সমস্যাটি আপনার করা সমস্ত কাজ ট্র্যাক করা উচিত। নিশ্চিত করুন যে সমস্যাটি সমস্ত প্রতিশ্রুতির তালিকা করে বা অন্য উপায়ে কমিটগুলি খুঁজে পাওয়া সহজ।

  • আপনার পরিবর্তনগুলির একটি ইউনিফাইড বা প্রসঙ্গের পার্থক্যের সাথে লিঙ্ক করুন৷ আপনার প্রযুক্তিগত লেখার প্রকল্পের নাম এবং আপনি কে, এমন একটি শিরোনাম অন্তর্ভুক্ত করতে ভুলবেন না, যাতে এটি অন্যদের জন্য দরকারী।

আপনার কাজের বর্ণনা কিভাবে খারাপ উদাহরণ

এই কাজগুলি করবেন না:

  • পুরো প্রোজেক্টের সোর্স কোড বা আপনার কাজের ডিরেক্টরি ধারণকারী একটি টারবল বা জিপ ফাইলের সাথে লিঙ্ক করুন।
  • প্রকল্পের প্রাথমিক উৎস সংগ্রহস্থলের শীর্ষে লিঙ্ক করুন। উদাহরণস্বরূপ, আপনি যদি cpython এ কাজ করেন তবে এই লিঙ্কটি কার্যকর নয়: https://github.com/python/cpython
  • প্রজেক্টের সোর্স রিপোজিটরির আপনার ক্লোনের সাথে লিঙ্ক করুন। এটি আপনার পরিবর্তনগুলি দেখতে কঠিন করে তোলে কারণ আপনার কাজ অন্য লোকেদের কাজের সাথে মিশ্রিত হয়।
  • সিজন অফ ডক্স ওয়েবসাইটে আপনার প্রকল্পের বিবরণের লিঙ্ক।

পরামর্শদাতাদের জন্য

অনুগ্রহ করে আপনার প্রযুক্তিগত লেখককে একটি সঠিক প্রকল্প প্রতিবেদন তৈরি করতে সাহায্য করুন। আপনি প্রযুক্তিগত লেখকের কাজের নিজস্ব মূল্যায়ন তৈরি করার আগে এটি করা গুরুত্বপূর্ণ।

নিম্নলিখিত পরীক্ষা করুন:

  • জমা উপরে বর্ণিত প্রয়োজনীয়তা পূরণ করতে হবে.
  • জমা দেওয়া কাজের একটি বিবরণ অন্তর্ভুক্ত করা আবশ্যক, প্রয়োজনীয়তা সন্তুষ্ট, এবং কোনো নির্দিষ্ট সিদ্ধান্ত নেওয়ার কারণ.

ডক্সের মরসুমের ধারণাটি এমন নয় যে প্রযুক্তিগত লেখকরা প্রচুর ডকুমেন্টেশন তৈরি করেন। এটি গুরুত্বপূর্ণ যে কাজটি হোস্টিং ওপেন সোর্স প্রকল্পের জন্য সম্ভাব্য উপযোগী।