1. Название проекта. Не забудьте дать своему проекту имя. Вы удивитесь, но это довольно сложная часть. Название должно быть лаконичным и отражать суть вашего проекта.
2. Введение или краткое описание. Напишите несколько предложений, которые поясняют, о чём ваш проект и для кого он предназначен.
3. Если это возможно, добавьте ссылку на демонстрацию работы или статью по проекту.
4. Описание данных, если в вашем проекте используется датасет.
5. Инструкции по сборке и запуску проекта. Добавьте раздел, где будут перечислены все знания и инструменты, необходимые тому, кто пожелает воспользоваться вашим проектом — сюда входит язык программирования и библиотеки (желательно с версиями).
6 Как установить ваш проект.* Опишите, как можно воспользоваться вашим кодом. Если проект целиком описан в Jupyter-ноутбуке, то достаточно указать основные команды git, которые позволят пользователю импортировать ваш проект себе в локальный репозиторий. Если ваш проект — это библиотека или целое приложение, то необходимо указать весь поэтапный процесс его установки и запуска.
7. Добавьте список контрибьюторов, если таковые имеются.
Перечислите людей, которые причастны к вашему проекту, со ссылками на их профили на GitHub. Это хороший способ демонстрации владения командной разработкой. К тому же, так вы сможете выразить благодарность людям, потратившим время на участие в вашем проекте.
8. Укажите информацию о лицензии.
Этот пункт не относится к учебным проектам, которые мы будем решать в рамках нашего курса. Однако если вы столкнётесь с разработкой собственной библиотеки или приложения, то пункт с лицензией на ваш продукт обязательно стоит упомянуть. Стартапы и прочие компании, использующие стороннее ПО, не смогут использовать ваш продукт, если не будут знать, на каких условиях это можно делать. Посмотреть виды лицензий можно на choosealicense.com или opensource.org. 9. Дополнительная информация.* Например, вы можете дать ссылки на похожие работы или статьи, которые проясняет некоторые термины.
10. Хорошим тоном будет указать раздел с выводами по проекту.
