অবদান

এই বইটি উন্নত করতে সাহায্য করার জন্য ধন্যবাদ। সব আকারের অবদান স্বাগত, বানান ভুল ঠিক করা থেকে নতুন বিষয় লেখা পর্যন্ত।

মৌলিক নিয়ম

বইটি একটি কঠোর গৃহশৈলী মেনে চলে। মূল কথাগুলো:

• এম-ড্যাশ নয়। কমা, কোলন, বন্ধনী বা দুটি বাক্য ব্যবহার করুন।
• গতানুগতিক বাক্যাংশ নয় (“not only … but also”, “load-bearing” এবং অনুরূপ)।
• উষ্ণ, সরল, সরাসরি লেখা। পাঠককে “আপনি” বলে সম্বোধন করুন। ছোট বাক্য।
• শব্দ প্রথম ব্যবহারে সংজ্ঞায়িত করুন। মূল ধারণা প্রথম উল্লেখে উইকিপিডিয়ার সাথে যুক্ত করুন।
• শুধু বাস্তব তথ্যসূত্র।
• প্রতিটি মেট্রিক-পরিবারের বিষয় তার হেরফেরের পথ ও গার্ডরেল চিহ্নিত করে।

পূর্ণ নিয়ম সংগ্রহস্থলের মূলে spec/conventions.md-এ, এবং সংক্ষিপ্ত সংস্করণ শৈলী নিয়ম। যান্ত্রিক অংশগুলো পরীক্ষা প্রয়োগ করে।

সেটআপ

আপনার Python 3 এবং just লাগবে। এই সংগ্রহস্থলে বইটির বিষয়বস্তু ও স্পেসিফিকেশন আছে, সাথে SvelteKit সাইট (software-engineering-metrics.github.io/) যা এটিকে প্রকাশিত ওয়েবসাইটে রূপ দেয়।

just         # list tasks
just test    # run the validation suite
just nav     # regenerate the generated navigation files
just stats   # topic and word counts

পরিবর্তন করা

1. প্রাসঙ্গিক নির্দেশিকা পড়ুন: বিষয়ের জন্য রচনা, উৎপন্ন ফাইলের জন্য নেভিগেশন, পরীক্ষার জন্য পরীক্ষা।
2. কাজটি করে এমন সবচেয়ে ছোট পরিবর্তন করুন।
3. কোনো বিষয় যোগ, অপসারণ, পুনঃনামকরণ বা পুনঃক্রমাঙ্কন করলে সংগ্রহস্থলের মূলে spec/structure.md হালনাগাদ করুন এবং just nav চালান।
4. just test চালান। এটি অবশ্যই পাস করতে হবে।
5. Unreleased-এর নিচে পরিবর্তন লগ-এ এক লাইনের একটি এন্ট্রি যোগ করুন।

কী নিয়ে কাজ করবেন

• ভুল, অস্পষ্ট অনুচ্ছেদ বা পুরনো তথ্যসূত্র ঠিক করুন।
• উদাহরণ উন্নত করুন, বিশেষত বাস্তব প্রাতিষ্ঠানিক ও সরকারি উদাহরণ।
• বাস্তব উৎসের বিপরীতে উদ্ধৃতি যাচাই করুন।
• টেমপ্লেট না ভেঙে কোনো বিষয়ের কভারেজের ফাঁক পূরণ করুন।

কী এড়াবেন

• উৎপন্ন ফাইল হাতে সম্পাদনা করবেন না (README.md, প্রতিটি লোকেলের index.md, front-matter/table-of-contents.md এবং topics/09-07-index.md)। এর বদলে বিষয় বদলান এবং just nav চালান।
• en-001, en-gb বা en-us সরাসরি সম্পাদনা করবেন না; এগুলো tools/localize.py দিয়ে en-gb-oxendict থেকে উৎপন্ন।
• spec/structure.md হালনাগাদ না করে বিষয় যোগ করবেন না।
• এম-ড্যাশ বা নিষিদ্ধ বাক্যাংশ আনবেন না; পরীক্ষা ব্যর্থ হবে।

সমস্যা জানানো

সমস্যা, ফাইল ও বিষয়, এবং প্রাসঙ্গিক হলে সঠিক উৎস বা তথ্যসূত্র বর্ণনা করে একটি ইস্যু খুলুন। ছোট, নির্দিষ্ট প্রতিবেদনের ওপর কাজ করা সবচেয়ে সহজ।