Skip to content

Commit b2075d5

Browse files
committed
1 parent c9a87b9 commit b2075d5

3 files changed

Lines changed: 243 additions & 12 deletions

File tree

.pre-commit-config.yaml

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@ repos:
22
- repo: https://github.com/mwouts/jupytext
33
rev: "v1.16.4b"
44
hooks:
5-
- id: jupytext
6-
entry: jupytext
7-
language: python
8-
types: [jupyter]
9-
args:
10-
- --from=ipynb
11-
- --to=py:light
12-
- --set-formats=ipynb,py:light
13-
- --quiet
14-
- --sync
15-
- --warn-only
16-
exclude: '.*\.md$' # excludes md files
5+
- id: jupytext
6+
entry: jupytext
7+
language: python
8+
types: [jupyter]
9+
args:
10+
- --from=ipynb
11+
- --to=py:light
12+
- --set-formats=ipynb,py:light
13+
- --quiet
14+
- --sync
15+
- --warn-only
16+
exclude: '.*\.md$' # excludes md files
1717
- repo: https://github.com/PyCQA/docformatter
1818
rev: "eb1df347edd128b30cd3368dddc3aa65edcfac38"
1919
hooks:
@@ -251,6 +251,9 @@ repos:
251251
require_serial: true
252252
types_or: [jupyter, markdown]
253253
additional_dependencies: [pydocstyle]
254+
env:
255+
PYTHONIOENCODING: utf-8
256+
254257
# - repo: https://github.com/christophmeissner/pytest-pre-commit
255258
# rev: 1.0.0
256259
# hooks:

python/issues.ipynb

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "code",
5+
"execution_count": null,
6+
"id": "562c42f2",
7+
"metadata": {},
8+
"outputs": [],
9+
"source": [
10+
"\"\"\"Конспект по GitHub Issues.\"\"\""
11+
]
12+
},
13+
{
14+
"cell_type": "markdown",
15+
"id": "a30b6b81",
16+
"metadata": {},
17+
"source": [
18+
"### Общие вопросы:\n",
19+
"\n",
20+
"1.Что такое Issues на GitHub и для чего они используются?\n",
21+
"#Система для отслеживания задач основные функции управлять, обсуждать, отслеживать рабочие вопросы\n",
22+
"2.Чем Issues отличаются от других инструментов управления задачами?\n",
23+
"#Автоматический связывает коммиты и пулл реквесты, отслеживает изменения в коде связанная с конкретной задачей, удобно использовать для обсуждения кода\n",
24+
"3.Какие основные компоненты (поля) есть у каждого Issue?\n",
25+
"#заголовок, описание, метки (labels), исполнители (assignees), вехи (milestones) и комментарии.\n"
26+
]
27+
},
28+
{
29+
"cell_type": "markdown",
30+
"id": "10aad8ec",
31+
"metadata": {},
32+
"source": [
33+
"### Создание Issues:\n",
34+
"\n",
35+
"1.Как создать новое Issue в репозитории?\n",
36+
"#Repository>Issues>New Issues\n",
37+
"2.Какие данные рекомендуется указывать в описании Issue для лучшего понимания задачи?\n",
38+
"#цель, инструкции, майлстон, прикрепить отвественого\n",
39+
"3.Какие теги (labels) можно добавить к Issue? Какие из них стандартные?\n",
40+
"#ошибка(bug), улучшение(enhancement), документация(documentation), нужна помошь(help wanted)\n",
41+
"4.Как прикрепить Assignees (ответственных) к Issue?\n",
42+
"#на боковой панели Issue в разделе Assignees выберите одного или нескольких пользователей\n"
43+
]
44+
},
45+
{
46+
"cell_type": "markdown",
47+
"id": "4f6844c2",
48+
"metadata": {},
49+
"source": [
50+
"### Работа с Issues:\n",
51+
"\n",
52+
"1.Как использовать Labels для классификации задач?\n",
53+
"#Метки используются для фильтрации и организации Issues\n",
54+
"2.Для чего нужен Milestone, и как связать его с Issue?\n",
55+
"#Чтобы связать Issue с вехой, выберите её на боковой панели в разделе Milestone, это группа Issues, объединённая общей целью, например, сроком или версией релиза\n",
56+
"3.Как привязать Issue к пул-реквесту (Pull Request)?\n",
57+
"#(#<номер ишьюса>) \n",
58+
"4.Как добавить комментарий к существующему Issue?\n",
59+
"#внизу страницы Issue в поле комент"
60+
]
61+
},
62+
{
63+
"cell_type": "markdown",
64+
"id": "f5cca504",
65+
"metadata": {},
66+
"source": [
67+
"### Закрытие и завершение Issues:\n",
68+
"\n",
69+
"1.Как закрыть Issue вручную?\n",
70+
"#Closes: #<номер ишью>\n",
71+
"2.Можно ли автоматически закрыть Issue с помощью сообщения в коммите или пул-реквесте? Как это сделать?\n",
72+
"#Closes/Fixes/Resolves: <номе ишью> \n",
73+
"3.Как повторно открыть закрытое Issue, если работа ещё не завершена?\n",
74+
"#нажимаем на Reopen issue"
75+
]
76+
},
77+
{
78+
"cell_type": "markdown",
79+
"id": "889ad6d9",
80+
"metadata": {},
81+
"source": [
82+
"### Фильтрация и поиск:\n",
83+
"\n",
84+
"1.Как найти все открытые или закрытые Issues в репозитории?\n",
85+
"#в строке поиска используйте is:open, is:closed.\n",
86+
"2.Как использовать фильтры для поиска Issues по меткам, исполнителям или другим критериям?\n",
87+
"#В строке поиска используйте синтаксис: label:bug, assignee:username, milestone:version-1.0\n",
88+
"3.Как сортировать Issues по приоритету, дате создания или другим параметрам?\n",
89+
"#выпадающее меню Sort в правой части страницы Issues, чтобы отсортировать по Newest (новые), Oldest (старые), Most commented (самые комментируемые) и другим критериям"
90+
]
91+
},
92+
{
93+
"cell_type": "markdown",
94+
"id": "87a2b9d3",
95+
"metadata": {},
96+
"source": [
97+
"### Интеграции и автоматизация:\n",
98+
"\n",
99+
"1.Как настроить автоматические уведомления о новых или изменённых Issues?\n",
100+
"#в разделе Notifications можно выбрать, о каких событиях вы хотите получать уведомления\n",
101+
"2.Что такое Projects в контексте GitHub, и как связать их с Issues?\n",
102+
"#помогают визуально отслеживать прогресс задач вы можете добавлять Issue на доску Project и перемещать его между колонками (To do, In progress, Done).\n",
103+
"3.Какие сторонние инструменты можно использовать для автоматизации работы с Issues (например, боты, Webhooks)?\n",
104+
"#GitHub Actions, Webhooks позволяют автоматизировать рутинные задачи, такие как назначение меток, закрытие неактивных Issues или создание новых"
105+
]
106+
},
107+
{
108+
"cell_type": "markdown",
109+
"id": "e51019d0",
110+
"metadata": {},
111+
"source": [
112+
"### Коллаборация:\n",
113+
"\n",
114+
"1.Как упомянуть другого пользователя в комментарии к Issue?\n",
115+
"#@username и GitHub отправит этому пользователю уведомление\n",
116+
"2.Как запросить дополнительные данные или уточнения у автора Issue?\n",
117+
"#комментарий в Issue, используя @username автора или отметить нужные строки кода и коментировать\n",
118+
"3.Что делать, если Issue неактуально или его нужно объединить с другим?\n",
119+
"#если Issue неактуально, его можно просто закрыть. Если оно дублирует другое, его можно закрыть, сославшись на оригинальный Issue"
120+
]
121+
},
122+
{
123+
"cell_type": "markdown",
124+
"id": "b459709c",
125+
"metadata": {},
126+
"source": [
127+
"### Практические аспекты:\n",
128+
"\n",
129+
"1.Как использовать шаблоны для создания Issues?\n",
130+
"#В репозитории можно создать папку .github и в ней файл ISSUE_TEMPLATE.md, который будет содержать определённую структуру для новых Issues\n",
131+
"2.Что такое Linked Issues, и как создать связь между задачами?\n",
132+
"#способ указать на связь между двумя или более Issues используя символ # и номер Issue.\n",
133+
"3.Какие метрики (например, время выполнения) можно отслеживать с помощью Issues?\n",
134+
"#Lead Time Это помогает измерить, насколько быстро команда способна решать задачи, Cycle Time Время, которое Issue находится в работе (с момента, когда его назначили исполнителю, до закрытия)\n",
135+
"4.Какие best practices рекомендуются при работе с Issues в команде?\n",
136+
"#однозначные заголовки, назначайте ответственных, используйте метки, обновляйте статус, закрывайте неактуальные Issues."
137+
]
138+
}
139+
],
140+
"metadata": {
141+
"language_info": {
142+
"name": "python"
143+
}
144+
},
145+
"nbformat": 4,
146+
"nbformat_minor": 5
147+
}

python/issues.py

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
"""Конспект по GitHub Issues."""
2+
3+
# ### Общие вопросы:
4+
#
5+
# 1.Что такое Issues на GitHub и для чего они используются?
6+
# #Система для отслеживания задач основные функции управлять, обсуждать, отслеживать рабочие вопросы
7+
# 2.Чем Issues отличаются от других инструментов управления задачами?
8+
# #Автоматический связывает коммиты и пулл реквесты, отслеживает изменения в коде связанная с конкретной задачей, удобно использовать для обсуждения кода
9+
# 3.Какие основные компоненты (поля) есть у каждого Issue?
10+
# #заголовок, описание, метки (labels), исполнители (assignees), вехи (milestones) и комментарии.
11+
#
12+
13+
# ### Создание Issues:
14+
#
15+
# 1.Как создать новое Issue в репозитории?
16+
# #Repository>Issues>New Issues
17+
# 2.Какие данные рекомендуется указывать в описании Issue для лучшего понимания задачи?
18+
# #цель, инструкции, майлстон, прикрепить отвественого
19+
# 3.Какие теги (labels) можно добавить к Issue? Какие из них стандартные?
20+
# #ошибка(bug), улучшение(enhancement), документация(documentation), нужна помошь(help wanted)
21+
# 4.Как прикрепить Assignees (ответственных) к Issue?
22+
# #на боковой панели Issue в разделе Assignees выберите одного или нескольких пользователей
23+
#
24+
25+
# ### Работа с Issues:
26+
#
27+
# 1.Как использовать Labels для классификации задач?
28+
# #Метки используются для фильтрации и организации Issues
29+
# 2.Для чего нужен Milestone, и как связать его с Issue?
30+
# #Чтобы связать Issue с вехой, выберите её на боковой панели в разделе Milestone, это группа Issues, объединённая общей целью, например, сроком или версией релиза
31+
# 3.Как привязать Issue к пул-реквесту (Pull Request)?
32+
# #(#<номер ишьюса>)
33+
# 4.Как добавить комментарий к существующему Issue?
34+
# #внизу страницы Issue в поле комент
35+
36+
# ### Закрытие и завершение Issues:
37+
#
38+
# 1.Как закрыть Issue вручную?
39+
# #Closes: #<номер ишью>
40+
# 2.Можно ли автоматически закрыть Issue с помощью сообщения в коммите или пул-реквесте? Как это сделать?
41+
# #Closes/Fixes/Resolves: <номе ишью>
42+
# 3.Как повторно открыть закрытое Issue, если работа ещё не завершена?
43+
# #нажимаем на Reopen issue
44+
45+
# ### Фильтрация и поиск:
46+
#
47+
# 1.Как найти все открытые или закрытые Issues в репозитории?
48+
# #в строке поиска используйте is:open, is:closed.
49+
# 2.Как использовать фильтры для поиска Issues по меткам, исполнителям или другим критериям?
50+
# #В строке поиска используйте синтаксис: label:bug, assignee:username, milestone:version-1.0
51+
# 3.Как сортировать Issues по приоритету, дате создания или другим параметрам?
52+
# #выпадающее меню Sort в правой части страницы Issues, чтобы отсортировать по Newest (новые), Oldest (старые), Most commented (самые комментируемые) и другим критериям
53+
54+
# ### Интеграции и автоматизация:
55+
#
56+
# 1.Как настроить автоматические уведомления о новых или изменённых Issues?
57+
# #в разделе Notifications можно выбрать, о каких событиях вы хотите получать уведомления
58+
# 2.Что такое Projects в контексте GitHub, и как связать их с Issues?
59+
# #помогают визуально отслеживать прогресс задач вы можете добавлять Issue на доску Project и перемещать его между колонками (To do, In progress, Done).
60+
# 3.Какие сторонние инструменты можно использовать для автоматизации работы с Issues (например, боты, Webhooks)?
61+
# #GitHub Actions, Webhooks позволяют автоматизировать рутинные задачи, такие как назначение меток, закрытие неактивных Issues или создание новых
62+
63+
# ### Коллаборация:
64+
#
65+
# 1.Как упомянуть другого пользователя в комментарии к Issue?
66+
# #@username и GitHub отправит этому пользователю уведомление
67+
# 2.Как запросить дополнительные данные или уточнения у автора Issue?
68+
# #комментарий в Issue, используя @username автора или отметить нужные строки кода и коментировать
69+
# 3.Что делать, если Issue неактуально или его нужно объединить с другим?
70+
# #если Issue неактуально, его можно просто закрыть. Если оно дублирует другое, его можно закрыть, сославшись на оригинальный Issue
71+
72+
# ### Практические аспекты:
73+
#
74+
# 1.Как использовать шаблоны для создания Issues?
75+
# #В репозитории можно создать папку .github и в ней файл ISSUE_TEMPLATE.md, который будет содержать определённую структуру для новых Issues
76+
# 2.Что такое Linked Issues, и как создать связь между задачами?
77+
# #способ указать на связь между двумя или более Issues используя символ # и номер Issue.
78+
# 3.Какие метрики (например, время выполнения) можно отслеживать с помощью Issues?
79+
# #Lead Time Это помогает измерить, насколько быстро команда способна решать задачи, Cycle Time Время, которое Issue находится в работе (с момента, когда его назначили исполнителю, до закрытия)
80+
# 4.Какие best practices рекомендуются при работе с Issues в команде?
81+
# #однозначные заголовки, назначайте ответственных, используйте метки, обновляйте статус, закрывайте неактуальные Issues.

0 commit comments

Comments
 (0)