При форматировании проблемы GitHub для MVVMcross, следуя лучших практиках могут повысить ясность, эффективность и сотрудничество. Вот несколько подробных рекомендаций:
1. Описательные названия **
Используйте императивное настроение и убедитесь, что название достаточно описательно, чтобы передать цель проблемы. Избегайте конечных названий с периодами. Например, «Исправить ошибку в привязке данных» более эффективна, чем «ошибка в привязке данных» или «ошибка привязки данных». [4] [7].2. Очистить обзор **
Предоставьте краткий обзор проблемы в двух строках или меньше. Это должно включать основную цель или проблему, которая рассматривается. Например, «эта проблема направлена на разрешение ошибки привязки данных, вызывающая сбои приложения на устройствах Android» [1] [4].3. Зависимость (если применимо) **
Если проблема зависит от другой проблемы, решаемой в первую очередь, ссылка на эту проблему. Это помогает поддерживать четкий рабочий процесс и гарантирует, что зависимые задачи решаются в правильном порядке. Например, «эта проблема зависит от [ссылки на зависимую проблему].» [1].4. Действия **
Формат действий элементы как кликабельные контрольные списки. Это позволяет легко отслеживать прогресс и назначать задачи членам команды. Например:- [] Исследуйте причину ошибки привязки данных.
- [] Реализуйте исправление для идентифицированной проблемы.
- [] Проверьте исправление на нескольких платформах. [1] [4].
5. Ресурсы/Инструкции **
Включите ссылки на соответствующую документацию или ресурсы, которые могут помочь в решении проблемы. Это может включать учебники, документацию API или предыдущие обсуждения, связанные с проблемой. Например, «см. [Документация MVVMcross] (https://mvvmcross.com/docs) для руководства по связыванию данных» [1] [2].6. Cessepeeders **
Назначьте проблему конкретному члену команды. Это обеспечивает ответственность и ясность в отношении того, кто несет ответственность за задачу. Используйте функцию «Комиссии» в GitHub, чтобы назначить пользователей. [1].7. Метки **
Применить соответствующие этикетки, чтобы классифицировать проблему. Это помогает в фильтрации и расстановке приоритетов проблем в рамках проекта. Например, этикетки могут включать «ошибку», «функцию» или «улучшение». [1] [2].8. Project Board **
Убедитесь, что проблема добавлена в Правление проекта и надлежащим образом триде. Это включает в себя установку статуса проблемы в «Ice Box», если он не готов, «приоритетное отставание», если он готов, но не назначен, и «в процессе» после назначения. [1].9. Вехи **
Используйте вехи, чтобы отслеживать прогресс групп проблем или запросов. Это особенно полезно для более крупных проектов или при отслеживании нескольких связанных задач. [1].10. Обновления документации и прогресса **
Регулярно обновлять комментарии проблемы с прогрессом или изменениями. Это держит все заинтересованные стороны информировать и облегчает совместное решение проблем. [7].Пример хорошо форматированной проблемы
** Название: исправить ошибку привязки данных на устройствах Android
** Обзор: Эта проблема рассматривает ошибку привязки данных, вызывающая сбои приложения на устройствах Android.
** Зависимость: зависит от [ссылки на зависимую проблему].
Действия:
- [] Исследовать причину ошибки привязки данных.
- [] Реализуйте исправление на основе выводов.
- [] провести тщательное тестирование на всех платформах.
** Ресурсы/инструкции: см.
** Правошники: @USERNAME
** Метки: ошибка, Android
Следуя этим рекомендациям, вы можете создать хорошо структурированные проблемы GitHub, которые повышают сотрудничество и эффективность в рамках проекта MVVMcross.
Цитаты:[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organize-information-with-tables
[4] https://tilburgsciencehub.com/topics/automation/version-control/start-git/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross-samples
[6] https://github.com/mvvmcross/mvvmcross-samples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-ractices-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md