Шаблон README.md

README.md

Название проекта

Добавьте краткое описание проекта, опишите какую задачу он решает. 1-3 предложения будет достаточно. Добавьте бейджи для важных статусов проекта: статус разработки (в разработке, на поддержке и т.д.), статус билда, процент покрытия тестами и тд.

Содержание

• Технологии
• Начало работы
• Тестирование
• Deploy и CI/CD
• Contributing
• To do
• Команда проекта

Технологии

• GatsbyJS
• TypeScript
• ...

Использование

Расскажите как установить и использовать ваш проект, покажите пример кода:

Установите npm-пакет с помощью команды:

$ npm i your-awesome-plugin-name

И добавьте в свой проект:

import { hi } from "your-awesome-plugin-name";

hi(); // Выведет в консоль "Привет!"

Разработка

Требования

Для установки и запуска проекта, необходим NodeJS v8+.

Установка зависимостей

Для установки зависимостей, выполните команду:

$ npm i

Запуск Development сервера

Чтобы запустить сервер для разработки, выполните команду:

npm start

Создание билда

Чтобы выполнить production сборку, выполните команду:

npm run build

Тестирование

Какие инструменты тестирования использованы в проекте и как их запускать. Например:

Наш проект покрыт юнит-тестами Jest. Для их запуска выполните команду:

npm run test

Deploy и CI/CD

Расскажите, как развернуть приложение. Как запустить пайплайны и т.д.

Contributing

Как помочь в разработке проекта? Как отправить предложение или баг-репорт. Как отправить доработку (оформить pull request, какие стайлгайды используются). Можно вынести в отдельный файл — Contributing.md.

FAQ

Если потребители вашего кода часто задают одни и те же вопросы, добавьте ответы на них в этом разделе.

Зачем вы разработали этот проект?

Чтобы был.

To do

• Добавить крутое README
• Всё переписать
• ...

Команда проекта

Оставьте пользователям контакты и инструкции, как связаться с командой разработки.

• Богдан Звягинцев — Front-End Engineer

Источники

Если вы чем-то вдохновлялись, расскажите об этом: где брали идеи, какие туториалы смотрели, ссылки на исходники кода.