গিথুব README.md তে কোন তথ্য থাকা উচিত?

Question

গিথুব README এ আপনি কী তথ্য দেখতে চান?

সবকিছুর README তে যাওয়া উচিত? অর্থাত

• ভূমিকা

• স্থাপন

• সংস্করণ

• ব্যবহারকারী গাইড

• বাস্তবায়ন

• পরীক্ষামূলক

• সম্পর্কিত সম্পদ

বা আপনার কি কেবল README (ভূমিকা, ইনস্টলেশন, সংস্করণ) এবং অন্যান্য তথ্যগুলিতে গিথুব উইকিতে সেরা কিছু রাখা উচিত?

Comments

আমি লাইসেন্সের

— শর্তাদিও রেখে দেব

অতিরিক্ত সাধারণ শব্দগুলিতে, প্রকল্প সম্পর্কে আমার জানা সমস্ত নাম যদি তা আমার পক্ষে কার্যকর হয় কিনা তা আমাকে জানাতে পর্যাপ্ত তথ্য থাকতে হবে। পাঠক এটি কীভাবে পেলেন সে সম্পর্কে কিছু অনুমান করবেন না।

— কিথ থম্পসন

এই প্রশ্নের এখানে খুব বিস্তৃত / ভাল উত্তর রয়েছে: stackoverflow.com/questions/2304863/how-to-write-a-

— রডরিগো গ্রাআ

Answer 1

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

Comments

সংক্ষেপে +1 "README" বলবেন না এবং তারপরে একটি গুচ্ছ আবর্জনা ফেলুন যা পড়ার দরকার নেই।

— কোরি হিন্টন