এই নিবন্ধটি কোরিয়ান ভাষায়ও উপলব্ধ, ধন্যবাদ Dohyung Ahn!
থম পারকিন আমার আগের একটি নিবন্ধের মন্তব্যে একটি দুর্দান্ত পয়েন্ট তৈরি করেছেন:
মহান উপদেশ. কিন্তু আপনি একটি অত্যন্ত গুরুত্বপূর্ণ [চূড়ান্ত] পয়েন্ট মিস করেছেন। যেহেতু এটি ওপেন সোর্স, আপনি একবার সেই বৈশিষ্ট্য/ফাংশনের বিশদ বিবরণ খুঁজে বের করার পরে যেখানে ডকুমেন্টেশনটি একটু হালকা, আপনাকে ডকস আপডেট করতে হবে এবং একটি পুল অনুরোধ জমা দিতে হবে। এইভাবে সমগ্র সম্প্রদায় উপকৃত হয়, এবং আপনি এমনকি আপনার অংশগ্রহণের জন্য কিছু "কোডার ক্রেড" অর্জন করতে পারেন!
আমি খুশি থম এটি উল্লেখ করেছে, কারণ এটি খুবই গুরুত্বপূর্ণ . ডকুমেন্টেশন ঠিক করা হল আপনার ব্যবহার করা এবং পছন্দের প্রজেক্টগুলিতে অবদান রাখা শুরু করার সবচেয়ে সহজ উপায়।
Rails, Rubinius, এবং Elixir-এর মতো প্রকল্পে আমার প্রথম অবদান সবই ডক ফিক্স করা হয়েছে। আমি জিনিসগুলি পরিষ্কার করার জন্য ছোট ছোট টুইক করেছি, এমন কিছু জিনিস ব্যাখ্যা করেছি যা আপনি শুধুমাত্র কোডটি পড়ার মাধ্যমেই আবিষ্কার করতে পারেন, এমনকি শুধু ভাঙা বিন্যাস ঠিক করা। কিছু বড় ওপেন সোর্স প্রকল্পগুলিকে সাহায্য করার জন্য এগুলি সবই দ্রুত, সহজ উপায়। এমনকি যখন তারা একটি প্রকল্পে আমার একমাত্র অবদান, তারা এখনও ভবিষ্যতের ব্যবহারকারীদের এবং ফিউচার মিকে সাহায্য করেছে। এবং এটিই ওপেন সোর্স সম্পর্কে।
কেন ডকুমেন্টেশন সংশোধনগুলি শুরু করার জন্য একটি দুর্দান্ত উপায়
ডক ফিক্সগুলি হল রেলের মতো একটি বড় প্রকল্পে অবদান রাখার জন্য সবচেয়ে কম ভীতিকর উপায়:
-
বাগ ঠিক করার জন্য আপনাকে প্রজেক্ট সেট আপ করতে হবে না . যেহেতু আপনি শুধু ডকুমেন্টেশন আপডেট করছেন, তাই আপনাকে পরীক্ষা বা অ্যাপ চালু করতে হবে না। কখনও কখনও, আপনাকে এমনকি আপনার মেশিনে প্রকল্পটি ক্লোন করতে হবে না – আপনি সরাসরি GitHub-এ আপনার পরিবর্তন করতে পারেন!
-
যদি রক্ষণাবেক্ষণকারী আপনাকে আপনার পুল অনুরোধে পরিবর্তন করতে বলে, সেগুলি সাধারণত শব্দ বা স্বাদের বিষয় হয় . এই ধরনের পরিবর্তনগুলি আপনার কোডের সমালোচনার চেয়ে পেটে সহজ হতে পারে। এবং এই পরিবর্তনগুলি করা আপনার পক্ষে সহজ, কারণ আপনাকে পরীক্ষা বা কোড আপডেট করতে হবে না, শুধু শব্দগুলি।
-
ডকুমেন্টেশন কঠিন একটি প্রকল্প রক্ষণাবেক্ষণকারীর জন্য, তাই আপডেটগুলি প্রশংসা করা হয় . প্রায়শই, লেখকরা বিভ্রান্তিকর অংশগুলি কোথায় তা বোঝার জন্য কোডের খুব কাছাকাছি থাকে। ডক্সের কোথায় সাহায্য প্রয়োজন তা জানাতে তাদের অন্য, নতুন ডেভেলপারদের প্রয়োজন। আপনার প্রকল্পকে একজন শিক্ষানবিস হিসেবে দেখতে অনুশীলন লাগে, এবং সবাই সেই দক্ষতা তৈরি করে না।
-
অবশেষে, আপনি একটি কম প্রভাব পরিবর্তন সহ রক্ষণাবেক্ষণকারীর সাথে একটি সম্পর্ক তৈরি করতে শুরু করছেন . আপনি প্রকল্পের দিক পরিবর্তন করছেন না, যেমন আপনি যদি একটি সম্পূর্ণ বৈশিষ্ট্য অবদান রাখেন। তাই আপনার পরিবর্তন একজন রক্ষণাবেক্ষণকারীর পক্ষে পর্যালোচনা করা সহজ এবং তারা সাধারণত আপনাকে আরও দ্রুত প্রতিক্রিয়া জানাবে। আপনার একত্রীকরণের অনুরোধ "এটি কি একটি ভাল ধারণা?" এ আটকে যাবে না? ফেজ।
আপনি সেই সম্পর্ক তৈরি করতে থাকলে, আপনাকে একজন নির্ভরযোগ্য অবদানকারী হিসাবে দেখা শুরু হবে। আপনার পুল অনুরোধগুলি দ্রুত পর্যালোচনা করা হবে, এবং আরও জটিল বৈশিষ্ট্য অনুরোধ এবং বাগ সংশোধনের মাধ্যমে কথা বলা আপনার উভয়ের পক্ষে সহজ হবে৷
এগুলি শুরু করা সহজ, সেগুলি করা সহজ এবং তারা আরও দ্রুত একত্রিত হওয়ার প্রবণতা রাখে৷ তাহলে কেন আপনার প্রথম অবদান ডক ফিক্স হবে না?
কিভাবে আপডেট করা ডকুমেন্টেশন আবার অবদান রাখা শুরু করবেন
ডক আপডেটে অবদান রাখার একটি গুরুত্বপূর্ণ উপায় হল বাগগুলি ঠিক করার মতো:তারা উভয়েই এমন জিনিসগুলির প্রতি সংবেদনশীল হওয়ার উপর নির্ভর করে যা ভুল মনে করে . আপনাকে মনোযোগ দিতে হবে।
যখন আপনি এমন আচরণে চলে যান যা আপনি আশা করেননি, তখন ডক্স আপডেট করার সময় হতে পারে। কোনো সমস্যা সমাধানের জন্য যদি আপনাকে কোডের মধ্যে ডুব দিতে হয়, তাহলে আপনি এটি সম্পর্কে অন্য লোকেদেরও বলতে চাইতে পারেন। এমনকি আপনার পড়া ডকুমেন্টেশনে ভাঙা বিন্যাস এবং টাইপোর প্রতি সংবেদনশীল হওয়া উচিত। আপনি যদি এটি ঠিক করতে না যান তবে কে করবে?
কোথায় পরিবর্তন করতে হবে এবং আপনি কীভাবে এটি বলতে চান সে সম্পর্কে আপনার ভাল ধারণা হয়ে গেলে, আপনার পরিবর্তন করুন এবং GitHub-এর মাধ্যমে একটি পুল অনুরোধ পাঠান।
আপনি যদি এখনও ডক্স আপডেট করার সর্বোত্তম উপায় সম্পর্কে সিদ্ধান্ত নেওয়ার চেষ্টা করছেন, GitHub-এ একটি সমস্যা খুলুন। এটি এরকম কিছু হতে পারে:
"আরে, এটি আমার কাছে বিভ্রান্তিকর ছিল। আমি এইরকম কিছু দেখতে এটি আপডেট করার কথা ভাবছিলাম:… আপনি কি মনে করেন? আর কিছু আমার উল্লেখ করা উচিত?" একসাথে, আপনি এমন শব্দ নিয়ে আসতে পারেন যা সবাইকে সন্তুষ্ট করে।
অবশেষে, আপনি যদি একটি প্রতিক্রিয়া না পান তাহলে নিরুৎসাহিত হবেন না। বড় প্রকল্পে অনেক কিছু চলছে, তাই আপনার অবদানের ফাটল ধরে যাওয়া সহজ। এক সপ্তাহের মধ্যে, আপনি যদি এখনও কারো কাছ থেকে শুনতে না পান, তাহলে রক্ষণাবেক্ষণকারীকে আবার জিজ্ঞাসা করুন .
যখন আপনি একটি লাইব্রেরির সাথে কাজ করেন তখন ডকুমেন্টেশন প্রায়ই প্রথম জিনিসটির সম্মুখীন হন, তাই এটি বিশদ এবং পরিষ্কার হওয়া গুরুত্বপূর্ণ৷
সুতরাং আপনি যে কোডটি ব্যবহার করেন সে সম্পর্কে আপনি যখন বিভ্রান্ত হন বা উৎসের মধ্যে ডুব দিতে হবে, তখন পরবর্তী ব্যক্তির জন্য এটি সহজ করুন। একটি দ্রুত আপডেট লিখুন, এবং এটি ফেরত অবদান. ওপেন সোর্স কন্ট্রিবিউটর হওয়ার জন্য এটি আমার জানা সবচেয়ে সহজ উপায়।
এই নিবন্ধটি মূলত আমার তালিকার লোকেদের কাছে পাঠানো হয়েছিল৷ এটির মতো আরও পড়তে, এখানে সাইন আপ করুন!