РЕДАКТИРОВАНИЕ БАГОВ
1. Редактирование при создании бага
При создании бага можно сразу добавить описание:
bash
Copy
Download
./bug-tracker create "Тест системы багов - проверка работы всех компонентов"
Но для добавления детального описания и комментариев нужно редактировать файл бага после создания.
2. Ручное редактирование багов
На главном компьютере (Ubuntu):
bash
Copy
Download
# Смотрим какие баги есть
./bug-tracker list
# Редактируем конкретный баг (замените 001 на нужный ID)
nano bugs/001-*.md
# Или используем графический редактор
gedit bugs/001-*.md
На Orange PI:
bash
Copy
Download
# Получаем свежие баги
./get-bugs
# Редактируем баг
nano bugs/001-*.md
# Или используем vim
vim bugs/001-*.md
3. Формат файла для редактирования
Пример содержимого файла бага:
markdown
Copy
Download
# Баг #001: Тест системы багов
**Статус:** 🔴 Открыт
**Автор:** alensav
**Дата:** 23.09.2025 19:26
## Описание
[ЗДЕСЬ ДОБАВЛЯЕТЕ ДЕТАЛЬНОЕ ОПИСАНИЕ ПРОБЛЕМЫ]
## Комментарии
[ЗДЕСЬ ДОБАВЛЯЕТЕ КОММЕНТАРИИ ПО ХОДУ РАБОТЫ]
4. Что добавлять в разделы
В раздел "Описание":
- Детальные шаги воспроизведения проблемы
- Ожидаемое поведение
- Фактическое поведение
- Скриншоты или логи (если есть)
- Окружение (ОС, версии ПО и т.д.)
В раздел "Комментарии":
- Ход investigation (что проверили)
- Результаты тестирования
- Предложения по решению
- Ссылки на документацию
- Дату и автора каждого комментария
5. Пример заполненного бага
markdown
Copy
Download
# Баг #001: Тест системы багов
**Статус:** 🔴 Открыт
**Автор:** alensav
**Дата:** 23.09.2025 19:26
## Описание
**Проблема:** Система багов не синхронизируется между устройствами
**Шаги воспроизведения:**
1. Создать баг на главном компьютере
2. Выполнить ./bug-tracker sync
3. На Orange PI выполнить ./get-bugs
4. Баг не появляется на Orange PI
**Ожидаемое поведение:** Баг должен синхронизироваться
**Фактическое поведение:** Баг не передается
**Окружение:**
- Ubuntu 18.04 32-bit
- Orange PI 64-bit
- Git версия 2.17.1
## Комментарии
**23.09.2025 alensav:** Проверил сетевую связность - ping проходит нормально
**24.09.2025 alensav:** Обнаружена проблема с правами доступа к репозиторию
**25.09.2025 alensav:** Исправлено, система работает корректно
6. Упрощенный скрипт для добавления комментариев
На главном компьютере создаем скрипт:
bash
Copy
Download
cat > bug-comment << 'EOF'
#!/bin/bash
cd ~/my-project
if [ -z "$1" ] || [ -z "$2" ]; then
echo "Использование: ./bug-comment <ID-бага> 'Текст комментария'"
exit 1
fi
FILE=$(find bugs -name "$1-*.md" | head -1)
if [ -f "$FILE" ]; then
echo "" >> "$FILE"
echo "**$(date +"%d.%m.%Y %H:%M") $(git config user.name):** $2" >> "$FILE"
echo "✅ Комментарий добавлен к багу #$1"
# Синхронизируем
git add "$FILE"
git commit -m "Комментарий к багу #$1"
git push bug-server master
else
echo "❌ Баг #$1 не найден"
fi
EOF
chmod +x bug-comment
Использование:
bash
Copy
Download
./bug-comment 001 "Проверил на Orange PI - проблема подтверждается"
7. Полный рабочий процесс редактирования
Шаг 1: Создать баг
bash
Copy
Download
./bug-tracker create "Проблема с компиляцией библиотеки XYZ"
Шаг 2: Редактировать описание
bash
Copy
Download
nano bugs/001-*.md
Добавить в раздел "Описание":
markdown
Copy
Download
## Описание
При компиляции возникает ошибка:
undefined reference to `function_xyz'
text
Copy
Download
Библиотека подключена, но функции не находятся.
Шаг 3: Добавить комментарии по ходу работы
bash
Copy
Download
./bug-comment 001 "Проверил версию библиотеки - 1.2.3"
./bug-comment 001 "Обновил до версии 1.2.4 - проблема осталась"
./bug-comment 001 "Нашел решение: нужно добавить флаг -lxyz при компиляции"
Шаг 4: Синхронизировать изменения
bash
Copy
Download
./bug-tracker sync
8. Быстрые команды для редактирования
Добавить описание к последнему багу:
bash
Copy
Download
# Находим последний баг
LAST_BUG=$(ls -t bugs/*.md | head -1)
nano "$LAST_BUG"
Просмотреть баг для редактирования:
bash
Copy
Download
# Смотрим список и выбираем ID
./bug-tracker list
# Редактируем выбранный баг
nano bugs/002-*.md
Добавить комментарий через командную строку:
bash
Copy
Download
# Быстрое добавление комментария
echo "**$(date):** Новый комментарий" >> bugs/001-*.md
🎯 КРАТКАЯ ШПАРГАЛКА
|
Действие |
Команда |
|
Создать баг |
./bug-tracker create "Описание" |
|
Редактировать описание |
nano bugs/001-*.md |
|
Добавить комментарий |
./bug-comment 001 "Текст" |
|
Синхронизировать |
./bug-tracker sync |
