مستندات (Documentation)

از این ساختار ↗ برای فایل README.md پروژه خود استفاده کنید؛ اگر بخش‌هایی وجود دارد که پوشش داده نشده است، می‌توانید آن‌ها را به‌دلخواه اضافه کنید.

اگر پروژه‌تان چندین مخزن (repository) دارد، لینک هر مخزن را در فایل‌های README.md مربوطه درج کنید.

با پیشرفت پروژه، فایل README.md را به‌روز نگه دارید تا همیشه منعکس‌کننده آخرین وضعیت باشد.

برای درک بهتر بخش‌های اصلی کد، کد خود را کامنت‌گذاری کنید، همچنین سعی کنید که به‌وضوح توضیح دهید که قصد انجام چه کاری را دارید.

اگر درباره کد یا روش مورد استفاده شما در گیت‌هاب یا استک‌اورفلو بحثی باز وجود دارد، لینک آن را در کامنت خود بگنجانید، تا سایر توسعه‌دهندگان بتوانند به بحث ایجاد شده دسترسی داشته باشند.

کامنت‌ها نباید توجیهی برای کد ضعیف باشند. کد خود را تا حد امکان تمیز بنویسید.

در عین حال از ارائه توضیحات تکمیلی در قالب کامنت، به این بهانه که کد تمیز می‌باشد، غافل نشوید.

با پیشرفت کد، کامنت‌ها را هم به‌روز کنید تا با وضعیت فعلی پروژه همخوانی داشته باشند.