فایلهای markdown پر کاربرد در یک ریپازیتوری گیت
اگر یک ریپازیتوری open source دارید و میخواهید این ریپازیتوری را استانداردتر کنید نیاز دارید از فایلهای markdown استفاده کنید تا افراد اطلاعات مورد نظر خود را از ریپازیتوری شما بدست آورند. در این نوشته فایلهای پرکاربرد مارکداون که در یک ریپازیتوری مرسوم است که وجود دارد را بررسی میکنیم.
پیشنهاد نویسنده: روش استفاده از فایل markdown
فایلهای markdown پر کاربرد در یک ریپازیتوری گیت
فایلهای معروفی که باید در یک ریپازیتوری است، به شرح زیر است:
- CONTRIBUTING.md : این فایل دستورالعملها و توضیحاتی را در ارتباط با روش مشارکت در ریپوزیتوری شما را توضیح میدهد.
- CODE_OF_CONDUCT.md : این فایل کد اخلاقی برای شرکت کنندگان در ریپازیتوری شما است.
- LICENSE.md : این فایل لایسنس ریپازیتوری شما است که معمولا افراد آن را به صورت خودکار توسط گیتهاب/گیتلب تولید میکنند.
- COPYING.md : این فایل مانند فایل LICENSE.md است و هر تفاوتی در استفاده ندارند.
اگر فایل دیگری را پیشنهاد میکنید که در یک ریپازیتوری گیت موجود است را در بخش نظرات نوشته برای ما بنویسید.
برای امتیاز به این نوشته کلیک کنید!
[کل: 1 میانگین: 5]



















آیا ترتیب وجود فایلها تو ریپازیتوری اهمیت داره یا فقط بودنشون کافیه؟
سلام، ممنون از سوال خوبتون. معمولاً ترتیب خاصی برای این فایلها در ریپازیتوری اهمیت نداره و مهم اینه که وجود داشته باشن تا اطلاعات لازم رو به کاربران بدن.
آیا نام فایلها باید حتما با حروف بزرگ باشه یا فرقی نمی کنه؟
سلام، نام فایلها معمولاً با حروف بزرگ نوشته میشود اما اجباری نیست و تفاوت چندانی در عملکرد ایجاد نمیکند.
چه فایل markdown دیگهای هست که معمولا همه ریپازیتوریها دارن؟
فایل README.md هم یکی از مهمترین فایلهای مارکداون هست که معمولاً در ریشه هر ریپازیتوری قرار داره و توضیحات کلی پروژه رو ارائه میده.
این فایلها روی GitLab و Bitbucket هم به همین شکل شناخته میشن؟
بله، این فایلها در پلتفرمهایی مانند GitLab و Bitbucket نیز به همین شکل شناخته شده و کاربرد دارند.
آیا میشه چند فایل markdown دیگه هم برای راهنمایی کاربران اضافه کرد؟
بله حتماً، اضافه کردن فایلهای راهنمای بیشتر برای کاربران بسیار مفید است. پیشنهاد شما را در نظر خواهیم گرفت.