Здача домашніх завдань

Опис вмісту репозиторію

Що потрібно включити

  • Кодова база

  • Залежності проекту (якщо застосовно)

  • (Додаткова) інформація про проєкт: README, CONTRIBUTING, LICENSE тощо.

Підказка

Завжди починайте новий репозиторій зі створення файлів README та .gitignore.

Що потрібно виключити

  • Віртуальне середовище, зазвичай папка venv або env

  • Байтовий скомпільований код Python (__pycache__)

  • Конфігурації IDE, зазвичай папка .vscode або .idea

  • Файли баз даних, такі як db.sqlite3

  • Інші речі, не пов’язані з завданням безпосередньо

Підказка

Налаштуйте .gitignore, щоб виключити всі шаблони назв з додавання до області сцени. Типовий вміст цього файлу може виглядати так:

/venv/
/env/
__pycache__/

Ініціалізація репозиторію

  1. Створіть та активуйте віртуальне середовище.

  2. Створіть загальні файли репозиторію:

    • README

    • .gitignore

    • requirements.txt (якщо застосовно)

  3. (Додатково) Створіть чорновий варіант кодової бази. Це може бути порожній модуль типу main.py або порожній проект Django.

  4. Ініціалізуйте новий репозиторій за допомогою команди git init.

  5. Налаштуйте шаблони імен .gitignore.

  6. Додайте зміни до stage-простору.

  7. Зафіксуйте зміни.

  8. Налаштуйте віддалений репозиторій.

  9. Перенесіть зміни з локальної гілки на віддалену.

Ініціалізація нового проекту Django

Базовий проект Django може бути доданий до сховища з першим коммітом. Ініціалізуйте проект Django у корені поточного сховища, щоб уникнути вкладеності каталогів.

$ django-admin startproject <project_name> .

Важливо

Не забудьте створити requirements.txt.

Після цього ви можете перейти до етапів «stage» та «commit».

Спільний доступ до залежностей проекту

Файл requirements.txt – це звичайний текстовий файл, який містить список усіх пакунків Python, необхідних для конкретного проекту. Цей файл використовується для вказівки залежностей у спосіб, що дозволяє контролювати версії та легко ділитися ними. Це дозволяє забезпечити узгодженість середовища в локальних налаштуваннях різних членів команди.

Де розмістити файл «requirements.txt»

Файл requirements.txt зазвичай розміщується у кореневому каталозі проекту.

Створення файлу «requirements.txt»

Щоб згенерувати файл, скористайтеся командою pip freeze і помістіть його вивід у файл:

$ pip freeze > requirements.txt

В результаті буде створено файл requirements.txt. Його вміст може мати вигляд:

asgiref==3.6.0
Django==4.1.5
psycopg2==2.9.5
sqlparse==0.4.3
tzdata==2022.7

Встановлення залежностей з файлу «requirements.txt»

Інший член команди може легко встановити всі вимоги до проекту за допомогою команди pip install:

$ pip install -r requirements.txt

Вирішення домашніх завдань (викликів)

  1. Створити нову гілку завдання

  2. Перейдіть до гілки завдання

  3. Виконайте роботу та зафіксуйте зміни

Підказка

Ви можете створити нову гілку і одразу перейти до неї:

git checkout -b <new_branch>

Створення запиту на злиття

  1. Переконайтеся, що ваша робоча гілка оновлена ​​до стандартної. Ви можете отримати зміни для гілки за замовчуванням і перебазувати свою гілку функції на неї.

  2. Перенести гілку функції до віддаленого сховища. За замовчуванням, поточна активна гілка виштовхується командою git push. Можливо, вам доведеться створити нову гілку, якщо вона ще не створена.

    git push -u origin <remote_branch>

  3. Перейдіть на головну сторінку вашого віддаленого сховища на GitHub і перейдіть на вкладку Pull requests.

  4. Натисніть кнопку New pull request.

  5. Виберіть гілку за умовчанням як ціль, а робочу гілку як джерело.

  6. Натисніть кнопку Create pull request.

  7. Надайте змістовну назву та короткий опис вашого запиту.

  8. Підтвердіть створення запиту.

  9. (Необов’язково) Виберіть рецензента(ів) у розділі Reviewers.

  10. Зачекайте, поки ваш запит буде розглянуто.

Налаштування рецензентів

Ви можете надіслати посилання на запит безпосередньо рецензенту, але краще вказати рецензента(ів) на сторінці запиту. Перш ніж ви зможете вибрати рецензентів, вам потрібно додати їх як учасників проекту.

Додавання співавторів

Рецензії дозволяють учасникам коментувати зміни, запропоновані у запитах, затверджувати їх або вимагати подальших змін до того, як запит буде об’єднано. Адміністратори сховища можуть вимагати, щоб запити на вилучення були затверджені перед об’єднанням.

  1. Перейдіть на головну сторінку вашого сховища на GitHub і перейдіть на вкладку Налаштування.

  2. Виберіть пункт меню Collaborators and teams.

  3. У розділі Manage access натисніть кнопку Add people.

  4. У модальному вікні почніть вводити ім’я користувача GitHub.

  5. Виберіть учасника зі спадного меню.

Це надішле запит вказаному користувачеві.

Об’єднання змін

Якщо ваш pull request буде схвалено - об’єднайте його в основну гілку. Виберіть один з доступних варіантів:

  • Create a merge commit

  • Rebase and merge

  • Squash and merge

Create a merge commit підходить у більшості випадків.

Внесення змін

Якщо ваш pull request буде відхилено або він матиме зауваження - вам може знадобитися надати деякі виправлення.

  1. Виконайте роботу у вашій місцевій тематичній гілці

  2. Надішліть їх до гілки віддаленого репозиторію

  3. Зробіть повторний запит на перегляд (за необхідності)

  4. Дочекайтеся завершення перевірки