У розробці

Репозиторії

Покращення будь-якого репозиторію

Якщо ви хочете покращити свій репозиторій, оскільки плануєте зробити його публічним або працювати з іншими людьми - то не завадить створити простий README.md, який одразу все пояснить і дасть іншим зрозуміти про проєкт, а також створити LICENSE для збереження ваших авторських прав або надання конкретних правил щодо цього.

Створення Readme

У створенні Readme немає нічого складного - але після нього багато що змінюється. Наприклад, уявіть, що ви заходите до репозиторію Yurba.js і там немає Readme - у вас може бути якесь смутне розуміння про бібліотеку з опису та категорій - але що вона робить і як її використовувати - ні. Але коли ви відвідуєте його, ви одразу бачите все, що потрібно (хоча це залежить від того, хто ви і яка ваша мета), як-от логотип і швидку інформацію про проєкт через значки, створені за допомогою shields.io Наприклад, версія основної бібліотеки, завантаження, реліз, останні тести, останній коміт, внесок і навіть останнє оновлення бібліотеки. І це вже дає багато. Після цього ви бачите About з короткою інформацією, потім пакети в проєкті, їх версії, посилання тощо. Через це вам не потрібно нікуди йти шукати, а бачити все одразу.

Сьогодні, використовуючи бота-посібника як приклад, я покажу вам, як створити простий Readme для вашого проєкту. Найімовірніше у вас виникне питання - з чого почати?