Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 76 additions & 39 deletions .github/PULL_REQUEST_TEMPLATE/task_submission_en.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,76 @@
<!--
Pull request title requirement:

"<LastName> <FirstName>. Technology <TECHNOLOGY_NAME:SEQ|OMP|TBB|STL|MPI>. <Full Task Name>. Variant <Number>"
-->

## Description
<!--
Please provide a detailed description of your implementation, including:
- key solution details (chosen algorithm description)
- parallelism technology application (if applicable)
-->

- **Task**: _Enter the full task name here_
- **Variant**: _Enter the variant number here_
- **Technology**: _Enter technology (e.g., SEQ, OMP, TBB, STL, MPI)_
- **Description** of your implementation and report.
_Provide a concise summary of your implementation and report here._

---

## Checklist
<!--
Please ensure the following items are completed **before** submitting your pull request and requesting a review:
-->

- [ ] **CI Status**: All CI jobs (build, tests, report generation) are passing on my branch in my fork
- [ ] **Task Directory & Naming**: I have created a directory named `<lastName>_<firstInitial>_<short_task_name>`
- [ ] **Full Task Definition**: I have provided the complete task description in the pull request body.
- [ ] **clang-format**: My changes pass `clang-format` locally in my fork (no formatting errors)
- [ ] **clang-tidy**: My changes pass `clang-tidy` locally in my fork (no warnings/errors)
- [ ] **Functional Tests**: All functional tests are passing locally on my machine
- [ ] **Performance Tests**: All performance tests are passing locally on my machine
- [ ] **Branch**: I am working on a branch named exactly as my task directory (e.g., `nesterov_a_vector_sum`), not on `master`.
- [ ] **Truthful Content**: I confirm that every detail provided in this pull request is accurate and truthful to the best of my knowledge.

<!--
NOTE: Untruthful entries in this checklist may result in PR rejection and zero points for the associated task.
-->
PR Title (enforced by CI):
- Pattern: [TASK] <Task>-<Variant>. <Last Name> <First Name> <Middle Name>. <Group>. <Task name>.
- Notes: `[TASK]` is optional; <Group> can be any text; there must be a dot and a space after each block.
- Example (RU): 2-12. Иванов Иван Иванович. 2341-а234. Вычисление суммы элементов вектора.
- Example (EN): 2-12. Ivanov Ivan Ivanovich. 2341-a234. Vector elements sum calculation.

PR Body (enforced by CI):
- Use the 12 sections below exactly as titled; do not include HTML comments.
- After each label line (e.g., `Assignment:`), provide non-empty text.

Commit Messages (enforced by CI):
- Subject pattern: <type>(<technology>|<task_folder>): <short_change_summary>
- Allowed types: feat, fix, perf, test, refactor, docs, build, chore
- Allowed technology: seq, omp, mpi, stl, tbb, all; or use your task folder name instead of a technology
- Subject length: ≤ 72 characters, then one blank line
- Required body sections: [What], [Why], [How], Scope: (Task/Variant/Technology/Folder), Tests:, Local runs:
- Example subject: feat(omp|nesterov_a_vector_sum): implement parallel vector sum
- Example body:
[What]
Add OMP reduction for vector sum.

[Why]
Improve performance and parallel coverage.

[How]
Use #pragma omp parallel for reduction(+:sum).

Scope:
- Task: 2
- Variant: 12
- Technology: omp
- Folder: nesterov_a_vector_sum

Tests:
Added unit and perf tests.

Local runs:
make test

Please fill in ALL sections below (no HTML comments). Use English headers as given.

## 1. Full name and group
Name and group:

## 2. Assignment / Topic / Task
Assignment:

## 3. Technology / Platform used
Technology:

## 4. Goals of the work
Goals:

## 5. Solution description and structure
Description:

## 6. System requirements and build instructions
Build & Run:

## 7. Testing and verification
Testing:

## 8. Results
Results:

## 9. Performance analysis
Analysis:

## 10. Conclusions and possible improvements
Conclusions:

## 11. Limitations / known issues
Limitations:

## 12. CI / static analysis / code style
CI & Style:
115 changes: 76 additions & 39 deletions .github/PULL_REQUEST_TEMPLATE/task_submission_ru.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,76 @@
<!--
Требования к названию pull request:

"<Фамилия> <Имя>. Технология <TECHNOLOGY_NAME:SEQ|OMP|TBB|STL|MPI>. <Полное название задачи>. Вариант <Номер>"
-->

## Описание
<!--
Пожалуйста, предоставьте подробное описание вашей реализации, включая:
- основные детали решения (описание выбранного алгоритма)
- применение технологии параллелизма (если применимо)
-->

- **Задача**: _Введите здесь полное название задачи_
- **Вариант**: _Введите здесь номер варианта_
- **Технология**: _Введите технологию (например, SEQ, OMP, TBB, STL, MPI)_
- **Описание** вашей реализации и отчёта.
_Кратко опишите вашу реализацию и содержание отчёта здесь._

---

## Чек-лист
<!--
Пожалуйста, убедитесь, что следующие пункты выполнены **до** отправки pull request'а и запроса его ревью:
-->

- [ ] **Статус CI**: Все CI-задачи (сборка, тесты, генерация отчёта) успешно проходят на моей ветке в моем форке
- [ ] **Директория и именование задачи**: Я создал директорию с именем `<фамилия>_<первая_буква_имени>_<короткое_название_задачи>`
- [ ] **Полное описание задачи**: Я предоставил полное описание задачи в теле pull request
- [ ] **clang-format**: Мои изменения успешно проходят `clang-format` локально в моем форке (нет ошибок форматирования)
- [ ] **clang-tidy**: Мои изменения успешно проходят `clang-tidy` локально в моем форке (нет предупреждений/ошибок)
- [ ] **Функциональные тесты**: Все функциональные тесты успешно проходят локально на моей машине
- [ ] **Тесты производительности**: Все тесты производительности успешно проходят локально на моей машине
- [ ] **Ветка**: Я работаю в ветке, названной точно так же, как директория моей задачи (например, `nesterov_a_vector_sum`), а не в `master`
- [ ] **Правдивое содержание**: Я подтверждаю, что все сведения, указанные в этом pull request, являются точными и достоверными

<!--
ПРИМЕЧАНИЕ: Ложные сведения в этом чек-листе могут привести к отклонению PR и получению нулевого балла за соответствующую задачу.
-->
Формат заголовка PR (проверяется CI):
- Шаблон: [TASK] <Task>-<Variant>. <Last Name> <First Name> <Middle Name>. <Group>. <Task name>.
- Примечания: `[TASK]` — опционально; <Group> может быть любым текстом; после каждого блока — точка и пробел.
- Пример (RU): 2-12. Иванов Иван Иванович. 2341-а234. Вычисление суммы элементов вектора.
- Example (EN): 2-12. Ivanov Ivan Ivanovich. 2341-a234. Vector elements sum calculation.

Описание PR (проверяется CI):
- Используйте 12 разделов ниже с точными заголовками; не добавляйте HTML-комментарии.
- После каждой метки (например, `Assignment:`) укажите непустой текст.

Описания коммитов (проверяется CI):
- Паттерн заголовка: <type>(<technology>|<task_folder>): <short_change_summary>
- Допустимые type: feat, fix, perf, test, refactor, docs, build, chore
- Допустимые technology: seq, omp, mpi, stl, tbb, all; либо используйте имя папки задачи вместо technology
- Длина первой строки ≤ 72 символа, затем пустая строка
- Обязательные секции тела: [What], [Why], [How], Scope: (Task/Variant/Technology/Folder), Tests:, Local runs:
- Пример subject: feat(omp|nesterov_a_vector_sum): implement parallel vector sum
- Пример тела:
[What]
Add OMP reduction for vector sum.

[Why]
Improve performance and parallel coverage.

[How]
Use #pragma omp parallel for reduction(+:sum).

Scope:
- Task: 2
- Variant: 12
- Technology: omp
- Folder: nesterov_a_vector_sum

Tests:
Added unit and perf tests.

Local runs:
make test

Заполните ВСЕ разделы ниже (без HTML-комментариев). Заголовки разделов оставьте на английском, как указано.

## 1. Full name and group
Name and group:

## 2. Assignment / Topic / Task
Assignment:

## 3. Technology / Platform used
Technology:

## 4. Goals of the work
Goals:

## 5. Solution description and structure
Description:

## 6. System requirements and build instructions
Build & Run:

## 7. Testing and verification
Testing:

## 8. Results
Results:

## 9. Performance analysis
Analysis:

## 10. Conclusions and possible improvements
Conclusions:

## 11. Limitations / known issues
Limitations:

## 12. CI / static analysis / code style
CI & Style:
78 changes: 74 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,76 @@
<!-- Solution for PR template choice: https://stackoverflow.com/a/75030350/24543008 -->
PR Title (enforced by CI):
- Pattern: [TASK] <Task>-<Variant>. <Last Name> <First Name> <Middle Name>. <Group>. <Task name>.
- Notes: `[TASK]` is optional; <Group> can be any text; there must be a dot and a space after each block.
- Example (RU): 2-12. Иванов Иван Иванович. 2341-а234. Вычисление суммы элементов вектора.
- Example (EN): 2-12. Ivanov Ivan Ivanovich. 2341-a234. Vector elements sum calculation.

Please go to the `Preview` tab and select the appropriate template:
PR Body (enforced by CI):
- Use the 12 sections below exactly as titled; do not include HTML comments.
- After each label line (e.g., `Assignment:`), provide non-empty text.

* [Submit Student task (English)](?expand=1&template=task_submission_en.md)
* [Submit Student task (Russian)](?expand=1&template=task_submission_ru.md)
Commit Messages (enforced by CI):
- Subject pattern: <type>(<technology>|<task_folder>): <short_change_summary>
- Allowed types: feat, fix, perf, test, refactor, docs, build, chore
- Allowed technology: seq, omp, mpi, stl, tbb, all; or use your task folder name instead of a technology
- Subject length: ≤ 72 characters, then one blank line
- Required body sections: [What], [Why], [How], Scope: (Task/Variant/Technology/Folder), Tests:, Local runs:
- Example subject: feat(omp|nesterov_a_vector_sum): implement parallel vector sum
- Example body:
[What]
Add OMP reduction for vector sum.

[Why]
Improve performance and parallel coverage.

[How]
Use #pragma omp parallel for reduction(+:sum).

Scope:
- Task: 2
- Variant: 12
- Technology: omp
- Folder: nesterov_a_vector_sum

Tests:
Added unit and perf tests.

Local runs:
make test

Please fill in ALL sections below (no HTML comments).

## 1. Full name and group
Name and group:

## 2. Assignment / Topic / Task
Assignment:

## 3. Technology / Platform used
Technology:

## 4. Goals of the work
Goals:

## 5. Solution description and structure
Description:

## 6. System requirements and build instructions
Build & Run:

## 7. Testing and verification
Testing:

## 8. Results
Results:

## 9. Performance analysis
Analysis:

## 10. Conclusions and possible improvements
Conclusions:

## 11. Limitations / known issues
Limitations:

## 12. CI / static analysis / code style
CI & Style:
Loading
Loading