Skip to content

Commit da3386f

Browse files
aobolenskaobolensk
authored
Add PR templates for fixes (#716)
close #702
1 parent b213f6c commit da3386f

File tree

3 files changed

+99
-0
lines changed

3 files changed

+99
-0
lines changed

‎.github/PULL_REQUEST_TEMPLATE/task_fix_submission_en.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!--
2+
Pull request title requirement:
3+
4+
"Fix: <LastName> <FirstName>. Technology <TECHNOLOGY_NAME:SEQ|OMP|TBB|STL|MPI>. <Full Task Name>. Variant <Number>"
5+
-->
6+
7+
## Description
8+
<!--
9+
Please provide:
10+
1) Original task details (what is being fixed)
11+
2) Fix details (what was wrong and what you changed)
12+
-->
13+
14+
### Original task details
15+
- **Task**: _Enter the full task name here_
16+
- **Variant**: _Enter the variant number here_
17+
- **Technology**: _Enter technology (e.g., SEQ, OMP, TBB, STL, MPI)_
18+
- **Student directory**: _Enter the directory name (e.g., `nesterov_a_vector_sum`)_
19+
- **Original PR / commit / issue link**: _Paste link(s) here_
20+
- **Original task definition**: _Paste the full task statement here_
21+
22+
### Fix details
23+
- **Problem**: _What is broken / incorrect? Include symptoms and expected behavior._
24+
- **Root cause**: _Why did it happen?_
25+
- **Fix summary**: _What exactly did you change?_
26+
- **Verification**: _What did you run locally?_
27+
28+
---
29+
30+
## Checklist
31+
<!--
32+
Please ensure the following items are completed **before** submitting your pull request and requesting a review:
33+
-->
34+
35+
- [ ] **CI Status**: All CI jobs (build, tests, report generation) are passing on my branch in my fork
36+
- [ ] **Task Directory & Naming**: I did not rename the existing task directory and did not introduce extra task directories
37+
- [ ] **Full Task Definition**: I have provided the complete original task description and the fix details in the pull request body
38+
- [ ] **clang-format**: My changes pass `clang-format` locally in my fork (no formatting errors)
39+
- [ ] **clang-tidy**: My changes pass `clang-tidy` locally in my fork (no warnings/errors)
40+
- [ ] **Functional Tests**: All functional tests are passing locally on my machine
41+
- [ ] **Performance Tests**: All performance tests are passing locally on my machine (if applicable)
42+
- [ ] **Branch**: I am working on a dedicated fix branch (not on `master`)
43+
- [ ] **Truthful Content**: I confirm that every detail provided in this pull request is accurate and truthful to the
44+
best of my knowledge.
45+
46+
<!--
47+
NOTE: Untruthful entries in this checklist may result in PR rejection and zero points for the associated task.
48+
-->

‎.github/PULL_REQUEST_TEMPLATE/task_fix_submission_ru.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!--
2+
Требования к названию pull request:
3+
4+
"Исправление: <Фамилия> <Имя>. Технология <TECHNOLOGY_NAME:SEQ|OMP|TBB|STL|MPI>. <Полное название задачи>. Вариант <Номер>"
5+
-->
6+
7+
## Описание
8+
<!--
9+
Пожалуйста, укажите:
10+
1) Данные об исходной задаче (что именно исправляется)
11+
2) Детали исправления (что было не так и что вы изменили)
12+
-->
13+
14+
### Данные об исходной задаче
15+
- **Задача**: _Введите здесь полное название задачи_
16+
- **Вариант**: _Введите здесь номер варианта_
17+
- **Технология**: _Введите технологию (например, SEQ, OMP, TBB, STL, MPI)_
18+
- **Директория студента**: _Введите имя директории (например, `nesterov_a_vector_sum`)_
19+
- **Ссылка на исходный PR / коммит / issue**: _Вставьте ссылку(и)_
20+
- **Полное описание исходной задачи**: _Вставьте полный текст условия_
21+
22+
### Детали исправления
23+
- **Проблема**: _Что сломано / неверно? Симптомы и ожидаемое поведение._
24+
- **Причина**: _Почему так произошло?_
25+
- **Суть исправления**: _Что именно вы изменили?_
26+
- **Проверка**: _Что запускали локально?_
27+
28+
---
29+
30+
## Чек-лист
31+
<!--
32+
Пожалуйста, убедитесь, что следующие пункты выполнены **до** отправки pull request'а и запроса его ревью:
33+
-->
34+
35+
- [ ] **Статус CI**: Все CI-задачи (сборка, тесты, генерация отчёта) успешно проходят на моей ветке в моем форке
36+
- [ ] **Директория и именование задачи**: Я не переименовывал существующую директорию задачи и не добавлял лишние директории задач
37+
- [ ] **Полное описание задачи**: Я указал полное описание исходной задачи и детали исправления в теле pull request
38+
- [ ] **clang-format**: Мои изменения успешно проходят `clang-format` локально в моем форке (нет ошибок форматирования)
39+
- [ ] **clang-tidy**: Мои изменения успешно проходят `clang-tidy` локально в моем форке (нет предупреждений/ошибок)
40+
- [ ] **Функциональные тесты**: Все функциональные тесты успешно проходят локально на моей машине
41+
- [ ] **Тесты производительности**: Все тесты производительности успешно проходят локально на моей машине (если применимо)
42+
- [ ] **Ветка**: Я работаю в отдельной ветке для исправления (а не в `master`)
43+
- [ ] **Правдивое содержание**: Я подтверждаю, что все сведения, указанные в этом pull request, являются точными и
44+
достоверными
45+
46+
<!--
47+
ПРИМЕЧАНИЕ: Ложные сведения в этом чек-листе могут привести к отклонению PR и получению нулевого балла
48+
за соответствующую задачу.
49+
-->

‎.github/pull_request_template.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@ Please go to the `Preview` tab and select the appropriate template:
44

55
* [Submit Student task (English)](?expand=1&template=task_submission_en.md)
66
* [Submit Student task (Russian)](?expand=1&template=task_submission_ru.md)
7+
* [Submit Fix for Student task (English)](?expand=1&template=task_fix_submission_en.md)
8+
* [Submit Fix for Student task (Russian)](?expand=1&template=task_fix_submission_ru.md)

0 commit comments

Comments
 (0)