На этот раз я решил поучаствовать в Хактоберфесте в качестве мейнтейнера проекта.

Проект представляет собой (AnadiCSV)[https://github.com/Cereal84/AnadiCSV] простой инструмент для запроса данных из CSV-файла с помощью SQL-запроса.

AnadiCSV написан на Python и использует DuckDB и Textual, проект был представлен на хактоберфесте в зачаточном состоянии. Идея заключалась в том, чтобы воспользоваться хактоберфестом по двум причинам:

• научитесь управлять проектом с участием «внешних» участников
• улучшите код, позволив людям внести свой вклад.

А теперь несколько уроков, которые я усвоил до сих пор.

Пишите подробные вопросы

Даже если для вас проблема совершенно ясна, это не значит, что то же самое касается и внешних участников, особенно если они не являются опытными.

Постарайтесь вести диалог по этому вопросу.

Деталей может быть недостаточно, лучше начать диалог, чтобы быть уверенным, что все понимают суть проделанной работы.

CONTRIBUTING файл важен

Я всегда игнорировал этот файл в своих репозиториях. Вместо этого, если вы хотите помочь людям внести свой вклад, это очень важно, вы можете написать, как вы ожидаете, что они будут работать, правила, которым нужно следовать, а иногда и то, какая логика лежит в основе какого-либо раздела ( то есть, если вы хотите добавить опцию cli, включающую все задействованные файлы, если это не так ясно в коде).

Проводить плохой обзор кода — не лучшая идея.

Иногда торопишься, но хочется как можно скорее объединить пиар; вы быстро читаете PR и вроде все в порядке, пропускаете некоторые файлы, потому что забываете о них или потому что думаете, что изменения будут настолько простыми, что наверняка они правильные.
Очевидно, они сломают репозиторий :).

Действия GitHub хороши

Добавление некоторых проверок, таких как форматирование кода, линтер и т. д., является хорошей идеей, чтобы избежать подобных действий во время проверки кода и позволить вам сосредоточиться на важных вещах.

Заключение

До сих пор я многому научился и рад, что начал этот проект, и советую всем попробовать сделать то же самое.

Всем, кто ищет проблемы на хактоберфесте, приходите к нам :).