mirror of
https://github.com/EDeev/mospoly-helper.git
synced 2026-06-15 19:11:11 +03:00
81 lines
4.8 KiB
Markdown
81 lines
4.8 KiB
Markdown
# Структура git-репозитория
|
||
|
||
Следует придерживаться предложенной структуры git-репозитория. При необходимости допускается создавать дополнительные папки верхнего уровня.
|
||
|
||
## Файловая структура git-репозитория
|
||
|
||
```plaintext
|
||
/
|
||
├── README.md
|
||
├── docs/
|
||
│ ├── README.md
|
||
│ ├── practice_documentation.md
|
||
│ └── ...
|
||
├── reports/
|
||
│ ├── README.md
|
||
│ ├── report.pdf
|
||
│ └── ...
|
||
├── site/
|
||
│ ├── index.html
|
||
│ ├── css/
|
||
│ │ └── style.css
|
||
│ └── images/
|
||
│ └── logo.png
|
||
├── src/
|
||
│ ├── main.py
|
||
│ └── ...
|
||
├── task/
|
||
│ ├── README.md
|
||
│ └── report_template.md
|
||
└── .gitignore
|
||
```
|
||
|
||
## Описание структуры git-репозитория
|
||
|
||
1. **README.md**
|
||
Файл, расположенный в корне репозитория, содержит основную информацию о проекте:
|
||
- Наименование практики.
|
||
- Период проведения.
|
||
- Участники (ФИО).
|
||
- ФИО ответственного по проектной (учебной) практике.
|
||
- Наименование проекта по «Проектной деятельности».
|
||
- ФИО куратора по проектной деятельности.
|
||
- Формулировка задания вариативной части.
|
||
Этот файл служит точкой входа для всех, кто работает с репозиторием.
|
||
|
||
2. **docs/**
|
||
Папка для размещения документации по практике в формате Markdown:
|
||
- **README.md** — основной файл с документацией, описывающий процесс выполнения практики.
|
||
- При необходимости могут добавляться дополнительные файлы Markdown.
|
||
|
||
3. **reports/**
|
||
Папка для хранения бинарных файлов отчётов:
|
||
- **report.pdf** — пример итогового отчёта в формате PDF.
|
||
- Возможны другие форматы (например, DOCX), если это требуется.
|
||
|
||
4. **site/**
|
||
Папка для статического сайта со всеми его ресурсами:
|
||
- **index.html** — главная страница сайта.
|
||
- **css/** — подпапка для файлов стилей:
|
||
- **style.css** — пример файла стилей.
|
||
- **images/** — подпапка для изображений:
|
||
- **logo.png** — пример изображения (логотип или другая графика).
|
||
Эта папка полностью изолирует ресурсы сайта от остальной части проекта.
|
||
|
||
5. **src/**
|
||
Папка для исходного кода, создаваемого в рамках вариативного задания:
|
||
- **main.py** — пример файла с кодом (например, на Python).
|
||
- Структура внутри папки может расширяться в зависимости от нужд проекта (дополнительные файлы или подпапки).
|
||
|
||
6. **task/**
|
||
Папка предназначена для хранения текста задания и шаблона отчёта:
|
||
- **README.md** — полный текст задания в формате Markdown.
|
||
- **report_template.md** — шаблон отчёта, который участники могут использовать для подготовки итоговых документов.
|
||
|
||
7. **.gitignore**
|
||
Файл в корне репозитория, используемый для исключения из коммитов временных файлов, кэшей или других ненужных данных (например, `__pycache__`, `*.log`).
|
||
|
||
## Преимущества структуры
|
||
|
||
- **Чёткое разделение:** Каждая папка отвечает за свою задачу, что упрощает навигацию и управление проектом. Все элементы (README, задание, документация, отчёты, код, сайт) имеют свои места в репозитории.
|
||
- **Гибкость:** Структура позволяет легко добавлять новые файлы в соответствующие разделы (например, дополнительные отчёты или код).
|