শৈলী নিয়ম (যৌথ, বলবৎযোগ্য)

গৃহশৈলী এক জায়গায়। “(test)” চিহ্নিত আইটেম tests/validate.py প্রয়োগ করে; লঙ্ঘন হলে বিল্ড ব্যর্থ হয়। পূর্ণ বর্ণনামূলক সংস্করণ সংগ্রহস্থলের মূলে spec/conventions.md।

কঠোর নিয়ম

এম-ড্যাশ নয়। কখনো ”—” (U+2014) ব্যবহার করবেন না। কমা, কোলন, বন্ধনী বা দুটি বাক্য ব্যবহার করুন। এন-ড্যাশ ”–” শুধু 1–9 বা 2.1–2.8-এর মতো সংখ্যাসূচক পরিসরে অনুমোদিত। (test)
গতানুগতিক বাক্যাংশ নয়। “not only … but also”, “but also” বা “load-bearing” ব্যবহার করবেন না। “It’s important to note”, “In today’s fast-paced world”, “It’s crucial to consider”, “It appears that”, “One could argue” এবং “it’s not just X, it’s Y” ছাঁচ এড়িয়ে চলুন। (test, প্রথম তিনটির জন্য)
শব্দ প্রথম ব্যবহারে সংজ্ঞায়িত করুন। প্রতিটি বিষয়ের প্রথম ব্যবহারে সংক্ষিপ্ত রূপ সম্প্রসারিত করুন এবং পরিভাষা সংজ্ঞায়িত করুন, যেমন “mean time to recovery (MTTR).”
মূল ধারণা উইকিপিডিয়ার সাথে যুক্ত করুন প্রথম উল্লেখে, প্রতি বিষয়ে একবার, শুধু গদ্যে। রূপ: [term](https://en.wikipedia.org/wiki/Article_Title)। কখনো শিরোনামে, টেবিলে, কোডে বা তথ্যসূত্র বিভাগে নয়। (লিঙ্কের রূপ একটি test)
শুধু বাস্তব তথ্যসূত্র। বাস্তব রচনার লেখক ও শিরোনাম। কোনো উদ্ভাবিত শিরোনাম, লেখক বা URL নয়।
হেরফেরের পথ চিহ্নিত করুন। একটি মেট্রিক-পরিবারের বিষয় বলে মেট্রিক কীভাবে হেরফের হয় এবং কোন গার্ডরেল তা ধরে (বিষয় ১.২)।

সুর

উষ্ণ, সরাসরি, উৎসাহব্যঞ্জক। পাঠককে “আপনি” বলে সম্বোধন করুন। ছোট বাক্য, সরল শব্দ। মূল কথা দিয়ে শুরু করুন।
মতামতধারী ও ব্যবহারিক। বিক্রেতা-নিরপেক্ষ। পণ্যের নাম কেবল বাস্তব উদাহরণ হিসেবে বলুন।

কাঠামো (test)

বিষয়বস্তু বিষয়গুলো chapter-template.md-এর সঠিক বিভাগ ক্রম ব্যবহার করে।
প্রথম শিরোনাম # N.M Title (দশমিক বিষয় নম্বর), এবং এটি ফাইলের শূন্য-পূরিত PP-CC উপসর্গের সাথে মেলে।
প্রতিটি পর্বের ভেতরে নম্বর ধারাবাহিক এবং N.0 থেকে শুরু।

সম্পাদনার পরে

বিষয়ের সেট বদলালে spec/structure.md হালনাগাদ করুন এবং just nav চালান।
সবসময় just test চালান।