কোডিং নীতি
ত্রুটি বার্তা
একটি ভাল ত্রুটি বার্তা ব্যবহারকারীকে নিম্নলিখিত পদক্ষেপগুলি সম্পর্কে অবহিত করে। প্লেগ্রাউন্ডের Public APIs দ্বারা প্রদত্ত ত্রুটিগুলিতে কোনও অস্পষ্টতা ডেভেলপারদের সমস্যাগুলি দেখতে উদ্বুদ্ধ করবে।
উদাহরণস্বরূপ, একটি নেটওয়ার্ক ত্রুটি বিবেচনা করুন - আমরা কি ত্রুটির ধরণটি অনুমান করতে পারি এবং পরবর্তী পদক্ষেপগুলির সংক্ষিপ্তসার সহ একটি প্রাসঙ্গিক বার্তা প্রদর্শন করতে পারি?
- নেটওয়ার্ক ত্রুটি: "আপনার ইন্টারনেট সংযোগটি বিকৃত হয়েছে। পৃষ্ঠাটি পুনরায় লোড করার চেষ্টা করুন।"
- ৪০৪: "ফাইলটি খুঁজে পাওয়া যাচ্ছে না".
- ৪০৩: "সার্ভার ফাইলটিতে অ্যাক্সেস ব্লক করেছে".
- CORS: স্পষ্ট করুন যে এটি একটি ব্রাউজার সুরক্ষা বৈশিষ্ট্য এবং একটি বিস্তারিত ব্যাখ্যার লিঙ্ক যুক্ত করুন (MDN বা অন্য কোনও নির্ভরযোগ্য উৎসে)। ব্যবহারকারীকে তাদের ফাইল অন্য কোথাও সরানোর পরামর্শ দিন, যেমন
raw.githubusercontent.com, এবং তাদের সার্ভারে CORS হেডার কীভাবে সেট আপ করবেন তা ব্যাখ্যা করে এমন একটি রিসোর্সের লিঙ্ক দিন।
আমরা কোড ফর্ম্যাটিং এবং লিন্টিং স্বয়ংক্রিয়ভাবে পরিচালনা করি। আরাম করুন, টাইপ করুন এবং মেশিনগুলিকে কাজ করতে দিন।
পাবলিক API
প্লেগ্রাউন্ডের লক্ষ্য হল সম্ভাব্য সবচেয়ে সংকীর্ণ API স্কোপ রাখা।
পাবলিক API যোগ করা সহজ এবং অপসারণ করা কঠিন। একটি নতুন API প্রবর্তন করতে কেবল একটি PR লাগে, তবে এটি অপসারণ করতে এক হাজার লাগতে পারে, বিশেষ করে যদি অন্যান্য প্রকল্প ইতিমধ্যে এটি ব্যবহার করে থাকে।
- অপ্রয়োজনীয় ফাংশন, ক্লাস, ধ্রুবক, বা অন্যান্য উপাদান প্রকাশ করবেন না।
ব্লুপ্রিন্ট
ব্লুপ্রিন্ট হল প্লেগ্রাউন্ডের সাথে ইন্টারঅ্যাক্ট করার প্রাথমিক উপায়। এই JSON ফাইলগুলি প্লেগ্রাউন্ড ক্রমানুসারে সম্পাদন করে এমন ধাপগুলির একটি সেট বর্ণনা করে।
নির্দেশিকা
ব্লুপ্রিন্টের ধাপগুলি সংক্ষিপ্ত এবং কেন্দ্রীভূত হওয়া উচিত। এগুলি একটি কাজ করা উচিত এবং ভালভাবে করা উচিত।
- যদি আপনার একটি নতুন ধাপ তৈরি করার প্রয়োজন হয়, তাহলে প্রথমে বিদ্যমান ধাপটি পুনর্নির্মাণের চেষ্টা করুন।
- যদি এটি যথেষ্ট না হয়, তাহলে নিশ্চিত করুন যে নতুন ধাপটি একটি নতুন ক্ষমতা প্রদান করে। বিদ্যমান ধাপগুলির কার্যকারিতা কপি করবেন না।
- ধরে নিন যে ধাপটি একাধিকবার কল করা হবে।
- ধরে নিন এটি একটি নির্দিষ্ট ক্রমে চলবে।
- এটি যাচাই করার জন্য ইউনিট পরীক্ষা যোগ করুন।
ব্লুপ্রিন্টগুলি স্বজ্ঞাত এবং সরল হওয়া উচিত।
- ঐচ্ছিক হতে পারে এমন আর্গুমেন্টের প্রয়োজন নেই।
- প্লেইন আর্গুমেন্ট ব্যবহার করুন। উদাহরণস্বরূপ,
pathএর পরিবর্তেslug। - ভার্চুয়াল JSON ফাইলগুলিতে কন্সটেন্ট সংজ্ঞায়িত করুন—PHP ফাইলগুলি পরিবর্তন করবেন না।
- ব্লুপ্রিন্টের জন্য একটি টাইপস্ক্রিপ্ট টাইপ সংজ্ঞা য়িত করুন। এভাবেই প্লেগ্রাউন্ড তার JSON স্কিমা তৈরি করে।
- ব্লুপ্রিন্ট ধাপ পরিচালনা করার জন্য একটি ফাংশন লিখুন। আপনার সংজ্ঞায়িত ধরণের আর্গুমেন্ট গ্রহণ করুন।
- ডক স্ট্রিংয়ে একটি ব্যবহারের উদাহরণ দিন। এটি স্বয়ংক্রিয়ভাবে ডক্সে প্রতিফলিত হয়।