Как создавать issue для людей

• Определитесь, на каком этапе сейчас проект
• Разбейте задачи на направления, в которых вам предстоит работать
• Определите, какие задачи вам необходимо сделать
• Поделите каждую задачу на атомарные таски. Чем меньше каждая - тем лучше и тем проще будет ее реализовать/проверить.
• Создайте issue с релевантными для задачи labels
  • Опишите суть задачи
  • Дайте ожидаемые input/output данные
  • Опишите acceptance criteria для задачи
  • Дайте необходимые описания/документацию/инструкции, необходимые для запуска проекта/выполнения задачи
  • Опционально добавьте дополнительную информацию, которую считаете нужной/полезной

Примеры хорших issue

Как принимать issue

Code Review Developer Guide from Google

Как решать issue

Вы хотите внести свой вклад в развитие проекта/продукта/помочь сообществу etc. Отлично! Наверняка у вас есть знания, которые помогут стать проекту лучше.

Ниже несколько рекомендаций, как наносить непоправимую пользу.

• Посмотрите, кому нужа помощь. Это может быть issue в open source проектах, например одном из этих. Либо задача от одного из ML4SG или ODSPetProjects.
• Посмотрите по тегам, какую проблему вы можете решить. Возможно, вам стоит обратить внимание на тег good first issue
• Внимательно прочитайте задачу. Задавайте вопросы, если вам что-то не понятно (перед этим неплохо прочитать code of conduct проекта, если он есть)
• Изучите Contribution guide, если он есть.
• Решите поставленную задачу, напишите тесты.
• Следуя Contribution guide проекта либо правилам хорошего тона, оформите свой pull request
• Опционально: передайте ваш commit на обзор в Slack ODS #ods_code_review
• Опционально: исправьте замечания