В последние пару месяцев я работаю над «новым» проектом с открытым исходным кодом — корпоративным приложением Stripe App с открытым исходным кодом!
Как я могу улучшить сотрудничество при написании проблем/тикетов? Читайте дальше, чтобы узнать мои мысли
Важность написания хороших тикетов в проектах с открытым исходным кодом
Если вы работаете над проектом с открытым исходным кодом (на github) вместе с другими людьми, разбросанными по всему интернету, очень важно писать четкие и ясные тикеты.
Таким образом, все будут знать, что нужно сделать, и никто не будет тратить время на то, что не нужно.
Существует несколько различных способов написания заявки.
Первый: использовать шаблон.
Шаблоны вопросов для проектов с открытым исходным кодом
Вы можете найти кучу шаблонов на github или в различных текстовых редакторах (например, VS Code). Использование шаблона гарантирует, что вы включите всю ✨ важную информацию в ваш тикет.✨
Однако шаблоны могут быть немного скучными. Возможно, вам придется настраивать шаблоны в соответствии с типом проекта, над которым вы работаете, поэтому выбирайте их с умом.
Другой способ написать тикет проблемы — просто указать название и краткое описание проблемы. Обычно этого достаточно для небольших проблем. Однако для более крупных проблем часто полезно включить больше информации, например, скриншоты, шаги по воспроизведению проблемы и т.д.
В целом, лучше выбрать слишком много информации, чем слишком мало. Таким образом, тот, кому поручено задание, сможет быстро понять проблему и приступить к ее устранению.
Как написать хороший тикет проблемы в проекте с открытым исходным кодом
Существует несколько лучших практик, которых следует придерживаться. Во-первых, обязательно включайте четкие и лаконичные заголовки и описания.
Если ваша проблема связана с конкретным фрагментом кода, укажите его в заявке. Также полезно включить:
- журналы
- скриншоты
- … или видео, если это применимо.
Наконец, не забудьте пометить проблему (НЕ помечайте непосредственно участников проекта), чтобы вы могли соответствующим образом классифицировать проблему.
Советы по написанию хорошего вопроса
Если вы новичок в области открытого исходного кода, совместной работы или просто хотите улучшить свои навыки составления отчетов о проблемах, прочитайте далее несколько советов о том, как написать хороший тикет проблемы.
1️⃣ Во-первых, обязательно включите в заголовок четкое и краткое описание проблемы. Это поможет другим быстро понять, в чем проблема и могут ли они помочь.
2️⃣ Затем предоставьте как можно больше подробностей в основной части проблемы. Включите скриншоты или скринкасты, если они помогут понять суть проблемы.
(Кстати, о скринкастах — мой друг Йен работает над тем, чтобы сделать скринкасты потрясающими на сайте replayable.io, если вы хотите передать ему немного любви — я буду благодарен за ваше время).
👉 И не забудьте включить любые соответствующие сообщения об ошибках или логи.
3️⃣ Наконец, если у вас есть идеи о том, как исправить проблему, не стесняйтесь указать их в тикете. Это может помочь сформировать решение в той или иной форме — кстати, это совершенно необязательно!
Надеюсь, это поможет, я использовал этот метод для своей собственной работы на Github и думаю, что он работает довольно хорошо!