SFM/README.md
2026-06-04 14:13:30 +03:00

48 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
__________________________________________________________________________________________________________
# sfm, v 0.0.1
__sfm__
| | Исполнитель | Заказчик |
|-----------|:----------------------------------------:|:----------------------------------------------:|
| Сотрудник | raykov-mse | raykov-mse |
| Отдел | aurora | aurora |
| Контакты | raykovmse@rshb.ru | raykovmse@rshb.ru |
-----
### Структура проекта:
![Структура проекта](/assets/image.jpg)
### Рабочий процесс:
1. Клонируем репозиторий
```commandline
git@<gitlab_url>:<group_name>/<project_name>.git
```
2. Создаем виртуальное окружение
```commandline
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
Если что-то устанавливаем, не забываем обновлять список зависимостей
```commandline
pip freeze -l > requirements.txt
```
3. Создаем feature ветку
```commandline
git checkout -b "feature-<task_number>-<short_task_description>"
```
4. Пишем свой код. Коммитим изменения
```commandline
git add .
git commit -m "<commit_message>"
```
Как писать хорошие коммит сообщения:
https://www.conventionalcommits.org/ru/v1.0.0/
5. Пушим изменения в Gitlab
```commandline
git push origin
```
6. Создаем Merge Request в master
7. Проходим код-ревью с коллегами
8. Мерджите