Вклад в проект DongTai IAST

Благодарим вас за желание внести свой вклад в развитие проекта DongTai IAST. Вы можете внести свой вклад различными способами:

• сообщать о проблемах;
• вносить изменения в код.

Отчёты об ошибках

Если вы считаете, что обнаружили ошибку в проекте DongTai IAST, сначала убедитесь, что вы тестируете последнюю версию проекта — возможно, ваша проблема уже была исправлена. Если нет, пожалуйста, следуйте инструкциям, чтобы описать проблему как можно более подробно при создании заявки.

Запросы на добавление функций

Если вам кажется, что в проекте DongTai IAST не хватает какой-то функции, пожалуйста, создайте заявку. Мы с нетерпением ждём новых идей от пользователей.

Внесение изменений в код

Если вы хотите добавить новую функцию или исправить ошибку в проекте DongTai IAST, пожалуйста, сначала обсудите свою идею на странице GitHub. Если для вашей идеи нет страницы GitHub, пожалуйста, создайте её. Мы всегда следим за заявками и предлагаем решения. Если вы никогда раньше не создавали запрос на внесение изменений, вот руководство по созданию такого запроса.

1. Если вы хотите написать код, который хотели бы внести в проект DongTai IAST, соблюдение следующих рекомендаций облегчит команде разработчиков DongTai IAST процесс проверки и принятия ваших изменений.

   Рекомендации по написанию кода

   • Следование последнему исходному коду.
   • Аккуратное форматирование кода.
   • Фиксация изменений:
     • просмотрите все свои изменения в патче или запросе на внесение изменений перед отправкой нам. Убедитесь, что всё, что вы изменили, имеет смысл.
     • пожалуйста, не включайте незавершённую работу в патч. Убедитесь, что он не содержит комментариев TODO. Если вы добавили код, но он оказался ненужным, пожалуйста, удалите его перед отправкой патча.
     • пожалуйста, не вносите изменения, которые влияют на форматирование, исправление «жёлтого кода» (предупреждений) или стиль кода вместе с фактическими изменениями, исправляющими ошибку или реализующими функцию. Никому не нравится оставлять плохой код, но помните, что смешивание этих изменений усложняет процесс проверки.
     • пожалуйста, не исправляйте несколько проблем в одном патче или запросе на внесение изменений.
     • пожалуйста, избегайте перемещения или переименования классов, если это не требуется для исправления.

2. Создайте ответвление проекта, клонируйте своё ответвление:

   git clone https://github.com/<your-username>/<repo-name>

3. Если вы клонировали некоторое время назад, получите последние изменения из вышестоящего репозитория:

   git checkout main
   git pull upstream main
   git submodule init

4. Создайте новую тематическую ветку (от основной ветки разработки проекта), чтобы содержать вашу функцию, изменение или исправление:

   git checkout -b <topic-branch-name>

5. Отправьте свою тематическую ветку в ваше ответвление:

   git push origin <topic-branch-name>

6. Откройте запрос на внесение изменений с чётким заголовком и описанием.

Ресурсы для участников

Уровень участника

• Участник: вы можете стать участником, отправив действительную заявку, внеся действительный запрос на внесение изменений или ответив на вопрос пользователя в сообществе.
• Сопровождающие: во-первых, вы должны быть участником; во-вторых, вы отправили важные заявки / запросы на внесение изменений или другие выдающиеся вклады; существующие сопровождающие и основные разработчики затем обсуждают, следует ли разрешить им присоединиться к команде сопровождающих.
• Основные члены команды: основным членам команды необходимо быть сопровождающими, а затем иметь собственные идеи и понимание развития продукта, они могут выдвигать ключевые предложения или разрабатывать связанные функции; существующие основные члены команды обсуждают вместе и решают, следует ли позволить им присоединиться к основной команде.