اوه آره ما به README شما تغییر شکل می دهیم!
README یکی از اولین چیزهایی است که کسی هنگام مشاهده پروژه شما مشاهده می کند. آن را به عنوان موضوع ایمیل خود یا زمین آسانسور برای ارائه خود در نظر بگیرید. README فرصتی است که می توانید فردی را به پروژه منبع باز خود علاقه مند کنید یا او را متقاعد کنید که یک توسعه دهنده عالی هستید یا به سادگی پروژه جالب خود را که در اوقات فراغت کار کرده اید به نمایش بگذارد.
با این حال ، گاهی اوقات README فراموش می شود. من آن را دریافت ، کد فقط نیاز به کار گاهی. اما ، من بسیار شما را تشویق می کنم که نگاهی به README های پروژه خود بیندازید و آنها را تکرار کنید.
در اینجا 3 زمینه وجود دارد که هنگام به روزرسانی یا ایجاد README های پروژه خود باید روی آنها تمرکز کنید.
پروژه خود را شرح دهید
می دانم ، این احتمالاً واضح به نظر می رسد ، اما تعجب خواهید کرد. به اندازه کافی در نمایه Github من عمیق شوید و چند repo با محتوای پیش فرض ، منسوخ شده یا “نفس نفس زدن” بدون README پیدا خواهید کرد. نوشتن در مورد کار شما یک موضوع کاملاً بزرگ است ، من یک بار دیگر به تفصیل می پردازم اما ، برای README شما می تواند ساده باشد.
برخی از س questionsالاتی که می توانید هنگام نوشتن شرح پروژه از خود بپرسید شامل موارد زیر است:
- این پروژه از چه فناوری هایی استفاده می کند؟
- چگونه شخص دیگری می تواند از آن استفاده کند؟
- چرا ایجاد شده است؟ یا ، چه مشکلی را حل می کند؟
- آیا این repo بخشی از یک پروژه بزرگتر است یا …