Skip to content

[TASK] Контрибьютинг в Open Source (https://github.com/SENATOROVAI/intro-cs/issues/8) - #774

Closed
olehpatsan wants to merge 9 commits into
SENATOROVAI:mainfrom
olehpatsan:task/8-open-source-update
Closed

olehpatsan wants to merge 9 commits into
SENATOROVAI:mainfrom
olehpatsan:task/8-open-source-update

Conversation

@olehpatsan

@olehpatsan olehpatsan commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Closes https://github.com/SENATOROVAI/intro-cs/issues/8

Что сделано и зачем

Сдача задания intro-cs#8 «Первый вклад в Open Source». Ветка пересобрана от свежего main основного репозитория: в PR только файлы этого задания и обязательные файлы стандартов репозитория, по одному файлу (или паре .ipynb + .py) на коммит, все коммиты в формате Conventional Commits, merge-коммитов нет.

Вклад в open source: issue google-deepmind/alphafold#1143 и pull request google-deepmind/alphafold#1144 (исправление B007 и устаревших ссылок deepmind/alphafold, CLA подписан).

Pre-release: https://github.com/olehpatsan/Data-Science-For-Beginners-from-scratch-course/releases/tag/v1.0.0-rc.1

Состав PR (11 файлов, 9 коммитов)

  • docs/github/images/close-pr.png: скриншот для ответа 3.2 (добавлен через git add -f, т.к. *.png в .gitignore).
  • docs/github/quiz.ipynb + quiz.py: тест по GitHub (часть 1), строки ≤ 79 символов, закрывающие тройные кавычки блока кода на отдельной строке.
  • docs/github/opensource.ipynb + opensource.py: анализ AlphaFold (часть 3), все цифры проверены на GitHub, указаны абсолютные даты (2026-11-03).
  • README.md: переписан по шаблону (Задания → Быстрый старт → Структура репозитория → Стандарты кода → Участие в проекте → Лицензия), бейджи CI/Python/License.
  • AUTHORS.md: мейнтейнер курса, автор форка и благодарности: все 44 пункта разделов «Улучшения репозитория», «Улучшения курсов», «Улучшение организации» перенесены из README дословно.
  • CODE_OF_CONDUCT.md: Contributor Covenant 2.1 (ru), контакт для жалоб через приватный GitHub-репорт.
  • SECURITY.md: поддерживаемые версии и порядок приватного сообщения об уязвимостях.
  • CONTRIBUTING.md: ссылка на лицензию LICENSE.md → LICENSE.
  • CHANGELOG.md: Keep a Changelog, раздел [1.0.0-rc.1] - 2026-11-03.

.gitignore, .github/dependabot.yml, log.ipynb, tests/quiz/* в PR не входят; остальные задания уже сданы отдельными PR.

Как проверить

  1. pre-commit run --files по файлам PR: все хуки проходят (проверено на Python 3.11).
  2. У каждого .ipynb в docs/github/ есть одноимённый .py.
  3. git log --oneline main..task/8-open-source-update: 9 коммитов, один файл или пара на коммит.

@olehpatsan olehpatsan left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

submit

Comment thread tests/quiz/open_source_quiz.py Outdated
Comment on lines +1 to +83
"""Open-source quiz."""

# Проект в который вы отправили пул реквест, попадает под определение опенсорса:
#
# Есть ли у него лицензия? Обычно в корне репозитория находится файл LICENSE.
#
# Ответ: Да.
#
# Напишите название понравившейся компании и ссылку на репозиторий
#
# Ответ: Google DeepMind — AlphaFold: https://github.com/google-deepmind/alphafold
#
# Проект активно принимает стороннюю помощь?
#
# Ответ: Да
#
# Напишите второе улучшение которое вы сделали
#
# Ответ: Исправил устаревшие ссылки `github.com/deepmind/alphafold`
# (ссылки на issues #10, #24, #463 возвращали 404)
# на `github.com/google-deepmind/alphafold` в `README.md`,
# `docs/technical_note_v2.3.0.md` и `pyproject.toml`.
# Первое улучшение — исправление замечания линтера B007 (неиспользуемая
# переменная цикла) в `alphafold/model/modules_multimer.py`.
#
# - Issue: https://github.com/google-deepmind/alphafold/issues/1143
# - Pull request: https://github.com/google-deepmind/alphafold/pull/1144
#
# Посмотрите на коммиты в основной ветке, напишите общее количество
#
# Ответ: 327.
#
# Когда был последний коммит?
#
# Ответ: 3 дня назад.
#
# Сколько контрибьюторов у проекта?
#
# Ответ: 33 контрибьютора.
#
# Как часто люди коммитят в репозиторий? (На GitHub выяснить это можно, кликнув по ссылке «Commits» в верхней панели.)
#
# Ответ: В среднем 3-5 коммитов в неделю.
#
# Сколько сейчас открытых ишью?
#
# Ответ: 122.
#
# Быстро ли мейнтейнеры реагируют на ишью после того, когда они открываются?
#
# Ответ: Да, отвечают в течение пары часов на вопросы по Issue.
#
# Ведётся ли активное обсуждение ишью?
#
# Ответ: В зависимости от ишью. Чаще просто один полный ответ от команды проекта.
#
# Есть ли недавно созданные ишью?
#
# Ответ: Да, 5 часов назад.
#
# Есть ли закрытые ишью? (На странице Issues GitHub-репозитория щелкните на вкладку «Closed», чтобы увидеть закрытые ишью.)
#
# Ответ: Да, 69 закрытых.
#
# Сколько сейчас открытых пул-реквестов?
#
# Ответ: 165 открытых и 338 закрытых.
#
# Быстро ли мейнтейнеры реагируют на пул-реквесты после их открытия?
#
# Ответ: Да, как и на Issue, дают полноценный ответ.
#
# Ведётся ли активное обсуждение пул-реквестов?
#
# Ответ: В зависимости от проблемы. Чаще нет.
#
# Есть ли недавно отправленные пул-реквесты?
#
# Ответ: Да, 5 часов назад вместе с ишью.
#
# Как давно были объединены пул-реквесты? (На странице Pull Request GitHub-репозитория щелкните на вкладку «Closed», чтобы увидеть закрытые пул-реквесты.)
#
# Ответ: Последний закрытый и смерженный pull request был неделю назад.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

review, please

@ruslansenatorov ruslansenatorov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@olehpatsan Привет! Спасибо за работу: у ноутбуков (кроме log.ipynb) есть парные .py, ветка task/8-open-source-update и заголовок оформлены по стандарту, привязка Closes https://github.com/SENATOROVAI/intro-cs/issues/8 на месте, ответ про AlphaFold со ссылками на issue и PR содержательный. Оставил 2 построчных замечания в open_source_quiz.py. Главные проблемы сейчас в составе PR и в стандартах задания open source.

Исправьте файлы и запушьте новый коммит, отвечать на комментарии не нужно.

Оформление PR

  • Состав. В PR 37 файлов и несколько разных заданий (commits, cpython, issues, stash, venv, github quiz, open source). Одна ветка = одно задание = один issue. Для этого PR оставьте только файлы задания open source (intro-cs#8). Остальные ответы вынесите в отдельные PR из своих веток.
  • Общие файлы и лишнее. Уберите изменения .gitignore (строка SENATOROV/), .github/dependabot.yml, а также log.ipynb, tests/quiz/environment.yml и tests/quiz/requirements.txt (не относятся к заданию #8). README.md меняется по заданию, но сейчас в нём только удалены чужие пункты благодарностей и добавлены контакты; нужна полная переработка по шаблону (см. ниже).
  • Коммиты. 33 коммита, среди них не в формате Conventional Commits: «Добавлен ноутбук c логом прохождения интро.», «Quiz1 and quiz2 are done!», «[TASK] Quiz #6(…)», «UPDATE README (#648)», «Update README.md», «Merge pull request #1…», «Merge pull request #2…», «merge: … quiz branch» (6 шт.). Merge-коммиты в ветке задания не нужны. Пересоберите историю от свежего main: git rebase -i, затем git push --force-with-lease (или создайте чистую ветку и перенесите нужные файлы).
  • Описание. Раздел «Changes» описывает только одну правку, а в PR 37 файлов. Опишите, что сделано и зачем, и перечислите реальный состав PR.
  • Расположение. Для задания open source ноутбуки должны лежать в docs/github/, а не в tests/quiz/. Нужны docs/github/quiz.ipynb + quiz.py и docs/github/opensource.ipynb + opensource.py (сейчас github_quiz.* и open_source_quiz.*). Исправить: git mv, коммит refactor: move task notebooks to docs/github.
  • Нет .py. Для log.ipynb нет .py. Если файл остаётся в PR, создайте пару (jupytext --to py:light log.ipynb); по смыслу его лучше убрать из этого PR.

Стандарты репозитория (задание open source, intro-cs#8)

В PR нет обязательных файлов:

  • README.md. Переписать по шаблону из issue #8: один заголовок # Название, разделы ## строго в порядке «Задания → Быстрый старт → Структура репозитория → Стандарты кода → Участие в проекте → Лицензия», бейджи CI, Python, License, таблица | Задание | Issue | Файлы | Статус | со ссылкой на intro-cs#8, блок bash с git clone, python -m venv, pre-commit install, дерево только из реально существующих папок, без меток ЗАПОЛНИТЬ/ВАШ_ЛОГИН.
  • AUTHORS.md. Авторы (мейнтейнер курса и вы) и раздел «Благодарности». Пункты разделов «Улучшения репозитория», «Улучшения курсов», «Улучшение организации» из README базового репозитория должны дословно перейти сюда; сейчас из README удалено 5 пунктов, и их нет ни в каком AUTHORS.
  • CODE_OF_CONDUCT.md. На основе Contributor Covenant (https://www.contributor-covenant.org/ru/version/2/1/code_of_conduct/) с контактом для жалоб. Путь: Insights → Community Standards → Code of conduct → Add.
  • SECURITY.md. Как сообщить об уязвимости не в публичном issue и какие версии поддерживаются. Путь: Security → Security policy → Start setup.
  • CHANGELOG.md. Формат Keep a Changelog (https://keepachangelog.com/ru/1.1.0/): раздел ## [X.Y.Z] - ГГГГ-ММ-ДД для версии из rc-тега, подразделы Added / Changed / Removed / Fixed, пункты по коммитам PR. Подсказка: git cliff --tag v1.0.0 -o CHANGELOG.md.
  • CONTRIBUTING.md. Проверьте, что файл есть и ссылка на лицензию ведёт на LICENSE, а не на LICENSE.md.
  • Коммиты (OS5). Один коммит = один файл (или пара .ipynb + .py).
  • Pre-release тег. Перед закрытием выпустите аннотированный тег v1.0.0-rc.N на последнем коммите, создайте по нему релиз с отметкой pre-release и добавьте ссылку в описание PR.

Файлы вашего репозитория мне недоступны, поэтому наличие файлов проверено по списку изменений PR; если они есть в вашей ветке, но не попали в PR, добавьте их в эту же ветку.


Generated by Claude Code

Comment thread tests/quiz/open_source_quiz.py Resolved
Comment thread tests/quiz/open_source_quiz.py Resolved
@olehpatsan
olehpatsan force-pushed the task/8-open-source-update branch from 7512a1f to a6d9b03 Compare November 3, 2026 18:22

Copy link
Copy Markdown
Member

@olehpatsan Привет! Проверил пересобранную ветку: состав PR (11 файлов задания и стандартов), расположение в docs/github/, история коммитов (один файл или пара на коммит, Conventional Commits, без merge-коммитов), README по шаблону, AUTHORS (все 44 пункта благодарностей перенесены дословно), CHANGELOG, абсолютные даты и длина строк в .py в порядке; мои прошлые замечания исправлены, треды закрыл. Остался один пункт: pre-release тег. Ваш репозиторий мне недоступен, поэтому тег и релиз я проверить не могу. Убедитесь, что аннотированный тег v1.0.0-rc.1 указывает на последний коммит a6d9b03 (ветка пересобрана, старый тег мог остаться на прежних коммитах; в этом случае выпустите v1.0.0-rc.2, отметьте релиз как pre-release и обновите ссылку в описании PR). Если тег уже на этом коммите, напишите здесь, и я проверю PR ещё раз.


Generated by Claude Code

@olehpatsan

Copy link
Copy Markdown
Member Author

Аннотированный тег v1.0.0-rc.1 указывает на последний коммит PR a6d9b03ff4421d980c9d59956897d4be844328b4 (tag object 850d1d2). Тег создан уже на пересобранной ветке, старого тега на прежних коммитах не было.

Релиз отмечен как pre-release: https://github.com/olehpatsan/Data-Science-For-Beginners-from-scratch-course/releases/tag/v1.0.0-rc.1 (ссылка есть в описании PR).

Проверка:

git ls-remote https://github.com/olehpatsan/Data-Science-For-Beginners-from-scratch-course 'refs/tags/v1.0.0-rc.1^{}'

Copy link
Copy Markdown
Member

@olehpatsan Привет! Проверил пересобранную ветку (9 коммитов, 11 файлов). Новых замечаний нет: состав и расположение файлов в docs/github/ в порядке, у ноутбуков есть пары .py, строки не длиннее 79 символов, коммиты в формате Conventional Commits, README, AUTHORS (пункты благодарностей перенесены дословно), CODE_OF_CONDUCT, SECURITY и CHANGELOG на месте, привязка Closes https://github.com/SENATOROVAI/intro-cs/issues/8 корректна.

Остался один пункт, который я не могу проверить: ваш репозиторий с тегом мне недоступен. Перед закрытием убедитесь, что аннотированный тег v1.0.0-rc.1 указывает на последний коммит ветки (a6d9b03, docs: add changelog for v1.0.0-rc.1), а релиз по нему отмечен как pre-release. Если тег стоит на более раннем коммите, выпустите v1.0.0-rc.2, создайте по нему pre-release и замените ссылку в описании PR.


Generated by Claude Code

@olehpatsan

Copy link
Copy Markdown
Member Author

Тег уже на этом коммите: аннотированный тег v1.0.0-rc.1 указывает на последний коммит ветки a6d9b03 (docs: add changelog for v1.0.0-rc.1), релиз по нему отмечен как pre-release. Выпуск v1.0.0-rc.2 не нужен.

Вывод git ls-remote для репозитория форка:

850d1d24130f878b85bc93a9050cc530a3b3a6a3	refs/tags/v1.0.0-rc.1
a6d9b03ff4421d980c9d59956897d4be844328b4	refs/tags/v1.0.0-rc.1^{}

Copy link
Copy Markdown
Member

@olehpatsan Проверил пересобранную ветку: в PR 11 файлов задания, ноутбуки лежат в docs/github/ с парными .py, строки в .py не длиннее 79 символов, коммиты в формате Conventional Commits без merge-коммитов, описание заполнено и содержит Closes https://github.com/SENATOROVAI/intro-cs/issues/8. README по шаблону (разделы в нужном порядке, три бейджа, таблица заданий, блоки bash и text), в AUTHORS.md перенесены все 44 пункта благодарностей, CODE_OF_CONDUCT, SECURITY и CHANGELOG на месте, ссылка на лицензию в CONTRIBUTING ведёт на LICENSE. Мои прошлые замечания исправлены, новых по файлам нет.

Осталась одна проверка: ваш репозиторий мне недоступен, поэтому тег v1.0.0-rc.1 и релиз я проверить не могу. Убедитесь сами, что тег аннотированный, указывает на последний коммит ветки (a6d9b03), а релиз по нему отмечен как pre-release. PR закрою после этой проверки.


Generated by Claude Code

@olehpatsan

Copy link
Copy Markdown
Member Author

Проверил тег и релиз, всё сходится, проверка пройдена:

PR готов к закрытию.

@ruslansenatorov ruslansenatorov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@olehpatsan Привет! Проверил новые коммиты: PR пересобран от свежего main, в нём 11 файлов задания, ноутбуки лежат в docs/github/ с парными .py, все 9 коммитов в формате Conventional Commits по одному файлу, слияний нет. README соответствует шаблону (разделы в нужном порядке, три бейджа, таблица заданий со ссылкой на intro-cs#8, дерево из реальных папок), все 44 пункта благодарностей дословно перенесены в AUTHORS.md, CODE_OF_CONDUCT.md, SECURITY.md, CHANGELOG.md на месте, ссылка на лицензию в CONTRIBUTING.md исправлена, строки в .py не длиннее 79 символов. Тег v1.0.0-rc.1 аннотированный и указывает на текущий последний коммит. Все мои прошлые треды закрыты, новых замечаний нет.

Осталось одно, что я не могу проверить сам: открыть страницу релиза v1.0.0-rc.1 и убедиться, что на ней стоит отметка Pre-release (не Latest и не Draft). Если так, замечаний больше нет.


Generated by Claude Code

@olehpatsan

Copy link
Copy Markdown
Member Author

Открыл страницу релиза v1.0.0-rc.1: стоит отметка Pre-release, не Draft и не Latest.

Подтверждение через публичный API GitHub:

$ curl -s https://api.github.com/repos/olehpatsan/Data-Science-For-Beginners-from-scratch-course/releases/tags/v1.0.0-rc.1 | jq '{prerelease, draft}'
{"prerelease": true, "draft": false}

$ curl -s https://api.github.com/repos/olehpatsan/Data-Science-For-Beginners-from-scratch-course/releases/latest
404 Not Found

Скриншот страницы релиза:

image Последний оставшийся пункт выполнен, других замечаний в ревью нет.

Copy link
Copy Markdown
Member

@olehpatsan Все замечания исправлены, закрываю PR. Спасибо за работу!

Остался финальный релиз — снимок вашего main:

  1. Выполните merge ветки задания в main своего репозитория.
  2. git switch main && git pull
  3. git tag -a v1.0.0 -m "v1.0.0: course completed" && git push origin v1.0.0
  4. Создайте релиз из тега v1.0.0 без отметки pre-release.
  5. Оставьте ссылку на релиз в комментарии к https://github.com/SENATOROVAI/intro-cs/issues/8

Generated by Claude Code

@olehpatsan
olehpatsan deleted the task/8-open-source-update branch November 4, 2026 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants