Для реализации проекта нам понадобится:
- Установить программу git на нашей операционной системе.
- Настроить программу и проверить её работоспособность локально (Познакомимся с основными командами и алгоритмами работы Git --> тык
- Скопировать репозиторий уже существующего проекта с помощью команды git clone "ссылка с GitHub"(Для копирования проекта с GitHub аккаунт не обязателен - лишь ссылка на уже существующий там проект со статусом "Pablic")
- Написать файл README.MD в рамках "правил хорошего тона" с кратким изложением сути проекта лежащего в данном репозитории
- Зарегистрировать наш аккаунт на сайте GitHub - https://github.com (Познакомимся с основными командами и алгоритмами работы GitHub --> тык)
- Создать удаленный репозиторий и подружить его с Git (Первая синхронизация проходит один раз - метод остаётся на усмотрение пользователя. При создании нового удалённого репозитория - GitHub также сразу предложит создать файлы README.MD + .gitignore + lisence и даст подробные инструкции в виде команд для работы с этим репозиторием)
- README file содержит подробное описание проекта — так другие разработчики узнают, какой репозиторий они смотрят и зачем он нужен.
- Gitignore позволяет сэкономить место и не заливать на GitHub лишние файлы. Например, можно исключить скрытые файлы Mac OS.
- License добавляет к коду ссылку на первоисточник и защищает права разработчика. Лицензия позволяет понять, как правильно использовать чужой код и можно ли его свободно внедрять в коммерческие проекты.
- Далее будим фиксировать (git commit) изменения локально
- Затем будим отправлять (git push) изменения на GitHub
- Поработаем с удалённым репозиторием напрямую посредством внутренних инструментов самого GitHub (Редактирование, создание и удаление веток, pull requests , удаление репозитория, комментарии)
- Дополнительно: в процессе реализации проекта ознакомимся с синтаксисом языка Markdown (облегчённый язык разметки, созданный с целью обозначения форматирования в простом тексте, с максимальным сохранением его читаемости человеком, и пригодный для машинного преобразования в языки для продвинутых публикаций)--> тык
Будим использовать IDE VS Code для работы с нашим проектом
В проекте присутствует документация в формате PDF поэтому поставим плагин для работы подобными типами файлаов в IDE VS Code - например: "vscode-pdf".