Як відбувається здача роботи
Для всіх дисциплін використовується єдина схема подання робіт:
Щоб здати роботу, підготуйте результати, README та пряме посилання на конкретну лабораторну або практичну роботу.
Виконайте завдання й збережіть усі результати.
Для окремих робіт із дисципліни «Основи штучного інтелекту» може використовуватися Kaggle Notebook. У такому випадку у форму здачі додається посилання на відповідний notebook.
Навіщо використовувати GitHub
GitHub використовується як робочий простір для навчальних проєктів. У ньому можна зберігати:
- вихідний код;
- SQL-скрипти;
- блок-схеми;
- UML-діаграми;
- Markdown-документацію;
- скріншоти;
- результати виконання;
- файли конфігурації;
- невеликі набори даних, якщо це передбачено завданням;
- історію змін проєкту.
Такий формат дозволяє зберігати всі матеріали роботи в одному місці та формує навички роботи з репозиторіями, які використовуються у професійній розробці програмного забезпечення.
Репозиторій для дисципліни
Для кожної дисципліни рекомендується створити окремий GitHub repository.
Приклади назв:
software-engineering
decision-methods
oop-cpp
software-modeling
artificial-intelligence
mobile-development
databases
Назва може відрізнятися. Вона має зрозуміло вказувати на дисципліну.
Структура репозиторію
Кожна лабораторна або практична робота розміщується в окремій папці.
Приклад:
mobile-development/
├── README.md
├── lab-01/
│ ├── README.md
│ ├── src/
│ └── screenshots/
├── lab-02/
│ ├── README.md
│ ├── src/
│ └── screenshots/
└── lab-03/
├── README.md
├── src/
└── screenshots/
Для практичних робіт можна використовувати:
practice-01/
practice-02/
practice-03/
Назви папок повинні бути послідовними й зрозумілими.
Що повинно бути в папці роботи
Склад папки залежить від дисципліни та завдання.
Зазвичай робота може містити:
README.md;- вихідний код;
- файл проєкту;
- схеми;
- SQL-файли;
- notebook;
- скріншоти;
- результати виконання;
- додаткові файли, передбачені завданням.
README.md — короткий звіт про роботу
Кожна робота повинна містити власний файл:
README.md
README допомагає швидко зрозуміти:
- хто виконав роботу;
- яке завдання виконувалося;
- що було реалізовано;
- як організовано рішення;
- який результат отримано.
README не потрібно перетворювати на великий формальний звіт. Він має бути компактним, структурованим і достатнім для перевірки роботи.
Шаблон README
# Лабораторна робота №1
## Дисципліна
Програмування мобільних застосунків
## Студент
ПІБ: Іваненко Іван Іванович
Група: ПЗ-23-1
## Тема роботи
Назва лабораторної або практичної роботи.
## Мета
Коротко сформулювати мету роботи.
## Завдання
Описати завдання та, якщо передбачено, свій варіант.
## Виконання
Коротко описати виконану роботу.
За потреби пояснити:
- структуру проєкту;
- основні класи або функції;
- використаний алгоритм;
- структуру даних;
- запити;
- прийняті технічні рішення.
## Результат
Описати отриманий результат.
## Скріншоти
Додати скріншоти роботи програми, схеми або іншого результату.
## Висновки
Коротко зазначити:
- що було реалізовано;
- які поняття опрацьовано;
- які труднощі виникли;
- який результат отримано.
Як додавати скріншоти
Для зображень рекомендується створювати папку:
screenshots/
Приклад:
lab-01/
├── README.md
└── screenshots/
├── screen-main.png
└── screen-result.png
У README зображення можна додати так:
GitHub покаже зображення безпосередньо на сторінці README.
Як оформлювати код
Основний код має знаходитися у файлах проєкту:
.kt
.cpp
.cs
.py
.sql
та інших файлах відповідного формату.
У README достатньо показувати невеликі фрагменти коду, якщо вони потрібні для пояснення конкретного рішення.
Історія змін і commits
Рекомендується виконувати роботу через кілька логічних commits.
Приклади:
create project structure
implement main algorithm
add input validation
add database queries
add screenshots
update README
Commit message має коротко описувати зміст зміни.
Що не потрібно завантажувати
Не додавайте до репозиторію файли, які автоматично генеруються середовищем розробки та не потрібні для перевірки.
Приклади:
build/
dist/
node_modules/
.gradle/
.idea/
bin/
obj/
Список залежить від технології.
Для програмних проєктів використовуйте .gitignore.
Блок-схеми, UML та інші діаграми
Схеми також здаються через GitHub.
Наприклад, для роботи з блок-схемами:
software-engineering/
└── lab-01/
├── README.md
└── flowcharts/
├── task-01.drawio
├── task-01.svg
├── task-02.drawio
└── task-02.svg
Рекомендується зберігати:
- вихідний файл, який можна редагувати;
- експорт у
SVGабоPNGдля швидкого перегляду; PDF, якщо це окремо передбачено завданням.
Приклад у README:
## Блок-схема
Посилання для здачі
У Google Form потрібно вставляти пряме посилання на конкретну роботу.
Приклад:
https://github.com/student/mobile-development/tree/main/lab-02
Доступ до repository
Перед здачею перевірте, що роботу можна відкрити за надісланим посиланням.
Якщо repository приватний, викладач повинен мати доступ до нього (username викладача - @steminist-ua). Рекомендація: робити repository публічними.
Перед надсиланням рекомендується відкрити посилання в приватному вікні браузера або перевірити налаштування доступу.
Повторна здача
Якщо роботу було доопрацьовано після перевірки:
- внесіть виправлення до того самого repository;
- зробіть новий commit;
- за потреби оновіть README;
- повторно надішліть Google Form;
- оберіть варіант «Повторна здача після виправлень».
Створювати новий repository для виправленої версії роботи не потрібно.
Особливості дисципліни «Основи штучного інтелекту»
Для цієї дисципліни окремі завдання можуть виконуватися у:
- GitHub;
- Kaggle Notebook.
Точний формат зазначається в умові конкретної лабораторної або практичної роботи.
Для роботи в Kaggle надішліть пряме посилання на Kaggle Notebook, доступний для перегляду викладачем. Структуру notebook, пояснення експериментів, візуалізації та висновки оформлюйте відповідно до інструкції конкретної лабораторної. Окремий repository потрібен лише тоді, коли цього вимагає завдання.