Skip to content

Commit a890c15

Browse files
nigmatullin244nigmatullin244
committed
Closes https://github.com/SENATOROVAI/intro-cs/issues/2
1 parent 8b6da62 commit a890c15

File tree

2 files changed

+196
-58
lines changed

2 files changed

+196
-58
lines changed

‎python/issues.ipynb‎

Lines changed: 68 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@
1717
"source": [
1818
"### Общие вопросы\n",
1919
"1. Что такое Issues на GitHub и для чего они используются?\n",
20-
" - Это инструмент для отслеживания задач, багов, который используется для планирования и управления работой в репозиториях GitHub. \n",
20+
" - Это инструмент для отслеживания и обсуждения различных задач, который используется для планирования и управления работой в репозиториях GitHub\n",
21+
"\n",
2122
"2. Чем Issues отличаются от других инструментов управления задачами?\n",
22-
" - Это простой и гибкий трекер задач, интегрированный с самим кодом, пул-реквестами, коммитами и проектами. В отличие от корпоративных систем (например, Jira), Issues не имеют избыточных настроек, категорий и атрибутов, а их кастомизация достигается с помощью меток, майлстонов, связанных задач и автоматизации через GitHub.\n",
23+
" - Issues интегрированы с GitHub, пул-реквестами, коммитами и проектами\n",
24+
"\n",
2325
"3. Какие основные компоненты (поля) есть у каждого Issue?\n",
2426
" - Title (Заголовок)\n",
2527
" - Description (Описание)\n",
@@ -28,109 +30,117 @@
2830
" - Milestone (Веха)\n",
2931
" - Projects (Связанные проекты)\n",
3032
" - Comments (Комментарии)\n",
31-
" - Issue type (Тип, если настроено в организации)\n",
33+
" - Issue type (Тип, если настроено)\n",
3234
" - State (Open/Closed — открыт/закрыт)\n",
3335
" - Linked issues / Pull requests (Связанные задачи или PR)\n",
36+
" - Participants (участники)\n",
3437
"\n",
3538
"### Создание Issues\n",
36-
"\n",
37-
"1. Как создать новое Issue в репозитории?\n",
39+
"4. Как создать новое Issue в репозитории?\n",
3840
" 1) Заходим в файл в репозитории \n",
3941
" 2) ЛКМ+shift-copy permalink\n",
4042
" 3) Issues - New issue - Выбираем тип Issues\n",
4143
" 4) Заполняем title и описание Issues\n",
4244
" 5) Issues - set milestone\n",
4345
" 6) Submit new issue\n",
44-
"2. Какие данные рекомендуется указывать в описании Issue для лучшего понимания задачи?\n",
45-
" - Указать ссылку на файл кода для issues\n",
46+
"\n",
47+
"5. Какие данные рекомендуется указывать в описании Issue для лучшего понимания задачи?\n",
48+
" - Указать ссылку на файл кода\n",
4649
" - Описание и название файла кода\n",
4750
" - Описание проблемы или задачи\n",
4851
" - Шаги для воспроизведения (если это баг)\n",
4952
" - Ожидаемое и фактическое поведение\n",
5053
" - Скриншоты или логи при необходимости\n",
5154
" - Возможные решения или идеи\n",
5255
" - Ссылки на связанные задачи или обсуждения\n",
53-
"3. Какие теги (labels) можно добавить к Issue? Какие из них стандартные?\n",
54-
" - Можно добавить стандартные и кастомные\n",
56+
"\n",
57+
"6. Какие теги (labels) можно добавить к Issue? Какие из них стандартные?\n",
58+
" - Можно добавить стандартные и кастомные теги\n",
5559
" - Стандартные: bug, enhancement, documentation, duplicate, good first issue, help wanted, invalid, question, wontfix\n",
56-
"4. Как прикрепить Assignees (ответственных) к Issue?\n",
60+
"\n",
61+
"7. Как прикрепить Assignees (ответственных) к Issue?\n",
5762
" - Assignees - выбрать пользователя или группу\n",
5863
"\n",
5964
"### Работа с Issues\n",
65+
"8. Как использовать Labels для классификации задач?\n",
66+
" - Выставить теги по типу и приоритету в Labels в окне Issues\n",
6067
"\n",
61-
"1. Как использовать Labels для классификации задач?\n",
62-
" - Выставить теги в Labels в окне Issues и поставить нужные теги\n",
63-
"2. Для чего нужен Milestone, и как связать его с Issue?\n",
68+
"9. Для чего нужен Milestone, и как связать его с Issue?\n",
6469
" - Для того, чтобы привязать Issue к дате или определенному этапу\n",
6570
" - Выставить дату или этап в Milestone в окне Issues\n",
66-
"3. Как привязать Issue к пул-реквесту (Pull Request)?\n",
67-
" - При создании pull request или коммита указать номер Issue в #123, либо использовать ключевые слова (\"Closes #123\", \"Fixes #123\")\n",
71+
"\n",
72+
"10. Как привязать Issue к пул-реквесту (Pull Request)?\n",
73+
" - В описании pull request указать #номер Issue или использовать ключевые слова (\"Closes #N\", \"Fixes #N\")\n",
6874
" - Можно вручную добавить связь через панель Linked issues\n",
69-
"4. Как добавить комментарий к существующему Issue?\n",
70-
" - В конце страницы Issue в поле комментария — написать текст и нажать \"Comment\", чтобы добавить сообщение\n",
75+
"\n",
76+
"11. Как добавить комментарий к существующему Issue?\n",
77+
" - Внизу страницы Issue написать комментарий\n",
7178
"\n",
7279
"### Закрытие и завершение Issues\n",
80+
"12. Как закрыть Issue вручную?\n",
81+
" - Issues - Close issue\n",
82+
"\n",
83+
"13. Можно ли автоматически закрыть Issue с помощью сообщения в коммите или пул-реквесте? Как это сделать?\n",
84+
" - Если в сообщении коммита или pull request использовать ключевые слова: \"Closes #номер\", \"Fixes #номер\", Resolves #номер\n",
7385
"\n",
74-
"1. Как закрыть Issue вручную?\n",
75-
" 1) Заходим в Issues\n",
76-
" 2) Находим Файл\n",
77-
" 3) Ветка - main\n",
78-
" 4) Редактируем файл\n",
79-
" 5) Commit changes\n",
80-
" 6) Commit message - тайтл Issues, Extended description - closes (Номер ошибки)\n",
81-
" 7) Sing off and commit changes\n",
82-
"2. Можно ли автоматически закрыть Issue с помощью сообщения в коммите или пул-реквесте? Как это сделать?\n",
83-
" - Если в сообщении коммита или pull request использовать ключевые слова: \"Closes #номер\", \"Fixes #номер\"\n",
84-
"3. Как повторно открыть закрытое Issue, если работа ещё не завершена?\n",
85-
" - Вкладка Issue - Выбрать Issue - Нажать \"Reopen issue\"\n",
86+
"14. Как повторно открыть закрытое Issue, если работа ещё не завершена?\n",
87+
" - Issue - Reopen issue\n",
8688
"\n",
8789
"### Фильтрация и поиск\n",
90+
"15. Как найти все открытые или закрытые Issues в репозитории?\n",
91+
" - Во вкладке Issues нажать \"Closed\" или в поиске написать is:open или is:closed для фильтрации\n",
8892
"\n",
89-
"1. Как найти все открытые или закрытые Issues в репозитории?\n",
90-
" - Во вкладке Issues по нажать \"Closed\" или в поиске, напишите is:open или is:closed для фильтрации.\n",
91-
"2. Как использовать фильтры для поиска Issues по меткам, исполнителям или другим критериям?\n",
92-
" - В поиске написать, например: label:bug assignee:username milestone:\"1.0.0\", либо использовать фильтры сверху (Labels, Assignee, Milestones, Projects).\n",
93-
"3. Как сортировать Issues по приоритету, дате создания или другим параметрам?\n",
93+
"16. Как использовать фильтры для поиска Issues по меткам, исполнителям или другим критериям?\n",
94+
" - В поиске написать, например: label:bug, assignee:username, milestone:\"1.0.0\", либо использовать фильтры сверху (Labels, Assignee, Milestones, Projects)\n",
95+
"\n",
96+
"17. Как сортировать Issues по приоритету, дате создания или другим параметрам?\n",
9497
" - В меню (\"Sort\") на вкладке Issues: доступны опции по дате создания, обновления, количеству комментариев и т.д. Приоритет обычно выставляется ярлыками (\"priority: high\")\n",
9598
"\n",
9699
"### Интеграции и автоматизация\n",
100+
"18. Как настроить автоматические уведомления о новых или изменённых Issues?\n",
101+
" - В репозитории - Watch\n",
102+
" - В Issue - Subscribe\n",
103+
"\n",
104+
"19. Что такое Projects в контексте GitHub, и как связать их с Issues?\n",
105+
" - Projects - это доски для визуального управления задачами. Issues можно добавлять в проекты для отслеживания статуса и автоматизации рабочих процессов\n",
97106
"\n",
98-
"1. Как настроить автоматические уведомления о новых или изменённых Issues?\n",
99-
" - В репозитории нажать \"Watch\" — выбрать интересующий вариант уведомлений\n",
100-
"2. Что такое Projects в контексте GitHub, и как связать их с Issues?\n",
101-
" - Projects - это доски для визуального управления задачами. Issues можно добавлять в проекты для отслеживания статуса и автоматизации рабочих процессов.\n",
102-
"3. Какие сторонние инструменты можно использовать для автоматизации работы с Issues (например, боты, Webhooks)?\n",
107+
"20. Какие сторонние инструменты можно использовать для автоматизации работы с Issues (например, боты, Webhooks)?\n",
103108
" - GitHub Actions (боты и скрипты для автоматизации работ)\n",
104109
" - Webhooks для интеграции с внешними сервисами\n",
105-
" - Сторонние боты типа probot, интеграция с Jira, Trello\n",
110+
" - Probot - платформа для GitHub ботов, \n",
111+
" - Интеграция с Jira, Trello\n",
106112
"\n",
107113
"### Коллаборация\n",
114+
"21. Как упомянуть другого пользователя в комментарии к Issue?\n",
115+
" - @username\n",
108116
"\n",
109-
"1. Как упомянуть другого пользователя в комментарии к Issue?\n",
110-
" - Использовать @username\n",
111-
"2. Как запросить дополнительные данные или уточнения у автора Issue?\n",
117+
"22. Как запросить дополнительные данные или уточнения у автора Issue?\n",
112118
" - Использовать упоминание в комментарии. Можно дополнительно добавить label \"needs info\"\n",
113-
"3. Что делать, если Issue неактуально или его нужно объединить с другим?\n",
114-
" - Для устаревших задач — закройте Issue с пометкой: \"Invalid\", \"Outdated\", кратко описав причину\n",
115-
"Для объединения — оставьте ссылку на дубликат (\"Duplicate of #номер\"), закройте и используйте ярлык \"duplicate\"\n",
119+
"\n",
120+
"23. Что делать, если Issue неактуально или его нужно объединить с другим?\n",
121+
" - Для устаревших задач закрыть Issue с пометкой: \"Invalid\", \"Outdated\"\n",
122+
" - Для объединения задач закрыть Issue с пометкой: \"Duplicate of #номер\"\n",
116123
"\n",
117124
"### Практические аспекты\n",
125+
"24. Как использовать шаблоны для создания Issues?\n",
126+
" - Создать файл .github/ISSUE_TEMPLATE.md\n",
127+
" - Если несколько несколько шаблонов, то создать папку .github/ISSUE_TEMPLATE/ добавить в нее файлы шаблонов с расширением .md\n",
128+
" - В Settings репозитория через кнопку \"Set up templates\" можно управлять шаблонами\n",
129+
"\n",
130+
"25. Что такое Linked Issues, и как создать связь между задачами?\n",
131+
" - Это задачи, логически связанные между собой (например, подзадачи). Связать можно с помощью панели \"Linked issues\", а также упоминанием через #номер в тексте\n",
118132
"\n",
119-
"1. Как использовать шаблоны для создания Issues?\n",
120-
" - В разделе Settings репозитория можно добавить шаблоны Issue (Issue Templates) для разных типов задач\n",
121-
"2. Что такое Linked Issues, и как создать связь между задачами?\n",
122-
" - Linked Issues - это задачи, логически связанные между собой (например, подзадачи). Связать можно с помощью панели \"Linked issues\", а также упоминания через #номер в тексте\n",
123-
"3. Какие метрики (например, время выполнения) можно отслеживать с помощью Issues?\n",
133+
"26. Какие метрики (например, время выполнения) можно отслеживать с помощью Issues?\n",
124134
" - Количество открытых/закрытых задач\n",
125135
" - Время выполнения задачи\n",
126136
" - Активность по assigned/closed issues\n",
127-
" - Число комментариев\n",
128-
"4. Какие best practices рекомендуются при работе с Issues в команде?\n",
129-
" - Используйте шаблоны и метки для стандартизации.\n",
130-
" - Назначайте ответственных\n",
131-
" - Описывайте задачи понятно, структурированно и без двусмысленности\n",
132-
" - Переводите устаревшие/дублирующие Issues в архив\n",
133-
" - Интегрируйте Issues в pipeline разработки через Pull Request’ы, Projects и автоматизацию"
137+
"\n",
138+
"27. Какие best practices рекомендуются при работе с Issues в команде?\n",
139+
" - Использовать шаблоны и метки для стандартизации\n",
140+
" - Назначать ответственных\n",
141+
" - Описывать задачи понятно, структурировано и без двусмысленности\n",
142+
" - Переводить устаревшие/дублирующие Issues в архив\n",
143+
" - Использовать ссылки и ключевые слова"
134144
]
135145
}
136146
],

0 commit comments

Comments
 (0)