Cheatsheet: Простий алгоритм для роботи з системою контролю версій (одна гілка, один розробник)
- Клонуйте ваш репозиторій (
git clone адреса) чи створіть його локально (git init). - Виконуйте необхідну роботу у середині теки репозиторію.
- Перевірте статус репозиторію (
git status). - Додайте нові файли (
git add файл чи тека), видаліть непотрібні файли (git rm файл) або додайте до коміту усі файли які були вже додані, але є модифіковані (git add -u). - Перевірте статус репозиторію — які файли увійдуть до наступного коміту (
git status). - Виконайте коміт. Додайте до коміта якісний коментар, який буде описувати ваші зміни. (
git commit -m “Коментар”) - Повторіть короки 2-6 допоки усі необхідні зміни в код не будуть внесені.
- Перед завершенням роботи обов’язково надішліть зміни до віддаленого репозиторію (
git push). Якщо репозиторій було створено локально зв’яжіть його з віддаленим перед командою push (git remote add origin адреса) та виконайте push (git push -u origin master)
Працюємо з Git правильно
Git є чудовим інструментом контролю версій, але у той же час велика кількість можливостей та деяка складність опанування можуть стати на заваді у розробника при знайомстві з ним. Велика гнучкість у використанні та розподіленість можуть бути як потужним інструментом, так і джерелом для потенційних помилок.
Використовуйте контроль версій
Які б чудові можливості не надавали системи контролю версій, початківці часто уникають їх використання. Зазвичай, це пояснюється тим, що це складно і що виникають проблеми з комітами. Але насправді, пропрацювавши 3-5 разів простий алгоритм роботи з однією гілкою Git, ви вже не будете більше стикатися зі складнощами, а з часом коміти ввійдуть у звичку.
Напрацьовуйте хороші звички
Попрацюйте та поексперементуйте з Git на прикладі простої програми. Особливо зверніть увагу на хороші практики описані тут. Як тільки звичка дійде до автоматизму - ви зможете зосередитися на програмуванні та вирішенні складніших задач. Ви перестанете непокоїтися про те, як працювати з репозиторієм, це стане звичною рутиною, а Git буде надійно зберігати пророблену вами роботу.
Використовуйте контроль версій постійно
Робота з Git - не тільки для С++\Qt зібрань PLLUG. Використовуйте все що ми вивчили постійно!
- В університеті для лабораторних робіт, практичних
- Заливайте в репозиторій тексти курсових та дипромних робіт
- Для власного проекту створіть окремий репозиторій у своєму Github акаунті, також можна створити окремий репозиторій для експериментів, навчальних програм та прикладів.
Найважливіше - це історія
Потрібно розуміти, що найціннішим у контролі версій є історія змін. Відповідно, має сенс докладати усіх зусиль, щоб історія змін була зрозумілою та логічною. Тоді і сам розробник і його колеги зможуть розібратися, чому у програму були внесені ті чи інші модифікації, попередити потенційні помилки, або ж легко знайти джерело помилки серед комітів у репозиторії.
Комітьте швидко та часто
Якщо ви маєте завдання - не спішіть програмувати. Продумайте, які зміни вам необхідні та розділіть роботу на невеликі частини. Робіть коміт для кожної з цих частин, як тільки її завершите.
Пишіть змістовні коментарі до комітів
Коментар має бути читабельним та зрозумілим не тільки для вас. Коментар пишуть повними реченнями англійською мовою з дотриманням правил граматики та пунктуації.
- Коментар має бути корисним
- Описуйте, що було змінено, де змінено, чому змінено.
- Зазвичай 1-3 речень більш ніж достатньо.
- Дотримуйтесь пунктуації, ставте крапку у кінці речення, починайте речення з великої букви. Повідомлення має виглядати нормальним текстом.
- Якщо описувати змін дуже багато - можливо необхідно було комітитися кілька разів. Розділіть зміни логічно на кілька комітів та зробіть окремі коміти.
Контролюйте зміст коміту
Переконайтеся, що код робочий та компілюється перед комітом
Коміт є своєрідною проміжною точкою роботи. Перконайтеся, що ви чи будь-хто хто повернеться до коміту буде здатним використати роботу виконану на той момент.
Комітьте тільки необхідне
Ваша задача - переконатися, що усі необхідні для розробки програми файли є під контролем версій. У той же час, уникайте додавання файлів, які можуть бути згенеровані у процесі роботи, а саме:
- Скомпільовані бінарні файли (програми, бібліотеки, тощо)
- Тимчасові файли, що були створені у процесі компіляції, і які не належать до вихідного тесту програми
- Файли, створені вашим текстовим редактором, оболонкою програмування у процесі роботи
- Файли, створені вашою програмою у процесі роботи