/CALCULATOR

An unexpected virtue of ignorance

Primary LanguageC

CALCULATOR (AKA HSE project one)

An unexpected virtue of ignorance

Мои дорогие чуваки! Я очень прошу вас тщательно прочитать данный текст. Надеюсь, я успею обсудить с вами все вопросы лично, чтобы данный документ был лишь напоминанием того, как нам надо писать этот проект. Всё это довольно важно как для успешной коммуникации между нами, так и для буста эффективности в целом. Сперва, конечно, вам стоит разобраться, что такое git и GitHub, как с ними работать, как с ними работать правильно, а не просто удобно. Если у вас появятся какие-то вопросы, вы можете обратиться ко мне либо загуглить, либо и то и другое. Пока мы не обсудили проект, здесь ниже будут только требования (это не просто мои хотелки, это стандартизация) к общему стилю написания кода и созданию коммитов. После нашего обсуждения я добавлю (если не забуду) наши роли в разработке.

  1. Общие требования к стилю написания кода:

    • Понятное именование переменных, функций и библиотек. Соблюдайте уместность, не придумывайте слишком длинные названия. Лучше, чтобы все слова были взяты из английского языка
    • camelCase для переменных и PascalCase для функций
    • Пытайтесь как можно больше функционала выделять в функциях, оставляя main минимально загруженным кодом
    • Оставляйте большое количество комментариев-описаний к тому, что вы пишете. Не ясно, как нам придётся защищать проект. Вдруг каждому понадобится ознакомиться со всему его частями. Так или иначе, подобная документация очень полезна

  2. Коммиты и прочее:

    • С осторожностью загружайте свои изменения в общий репозиторий. Проверяйте, чтобы всё работало. Проверяйте тщательно. Работайте на отдельных ветках, их мы придумаем и создадим позже
    • Пишите комментарий к коммиту, если понадобится - длинный. Главное, чтобы он был подробным.
    • Делайте коммиты осмысленно. Один коммит = одна фича/фикс. То есть коммиты лучше делать часто. Так будет проще найти работающую версию, если что-то сильно сломается

Обратите внимание!

Пункт (1) носит скорее рекомендательный характер (помимо, разве что, пункта о документации), в то время как пункт (2) - обязательный. Он ещё будет дополняться.

Хорошей работы, мои чуваки

UPD:

Далее последуют инструкции для клонирования проекта на ваши ПК и настройку SSH соединения для упрощения работы с git. Надеюсь на данный момент вы успели разобраться в сути его применения. Итак, что следует сделать для клонирования проекта и настройке соединения для последующей работы:

  • Сгенегируйте SSH ключ и добавьте его в ваш аккаунт через Settings->SSH and GPG keys->New SSH key. Гереация ключа состоит из следующих шагов:
    • Откройте PowerShell (скачайте, если у вас он отсутствует, - он удобен)
    • Введите команду ssh-keygen
    • У вас появится строка Enter file in which to save the key(~/.ssh/id_rsa):, где в скобках указан некий адрес к иерархии файлов. Это - дефолтно сгенерированный путь до ещё не созданного файла. Если вы нажмёте Enter, то ключ сохранится по этому адресу. Так как вы не крутые безопасники, то забейте и жмите Enter.
    • Далее у вас появится предложение ввести пароль для ключа. Тоже забейте и жмите Enter оба раза.
    • Готово. Ключ у вас есть. Далее введите команду cat ~/.ssh/id_rsa.pub | clip. Это скопирует ключ в буфер обмена. Заходите в гитхаб по указанной выше ссылке, добавляйте ключ. Назовите его как-то для удобства, вставьте ключ в соответствующее поле. Ничего не редактируйте.
  • Скачайте .zip файл с проектом. Это можно сделать так: Снимок экрана (36)
  • Перейдите в папку с проектом.
  • Теперь настроим SSH соединение:
    • Так как сам ключ у вас уже привязан, создавать новый не придётся. Введите следующую команду ssh -T git@github.com. Последует вывод, в котором вроде как спрашивается, доверяете ли вы этому источнику и всё такое. Жмите Enter.
    • Последний этап. Введите git remote set-url origin git@github.com:luckyComet55/CALCULATOR.git. это должно сработать.

Это конец инструкции по установке проекта. Внутри вы найдёте комментарии к блокам с кодом. Можете работать. Работайте не на ветке master, на данном этапе вам нужна ветка parameters. Регулярно делайте коммиты и пуши. При проблеме с клонированием пишите мне, вдруг я где-то опечатку сделал.