Вклад в проект World Locking Tools для Unity
Самый ценный способ участвовать в работе над проектом World Locking Tools для Unity в настоящее время — отправлять сообщения об обнаруженных проблемах. Все отзывы и предложения по повышению эффективности проекта World Locking Tools для Unity в соответствии с потребностями вашего проекта очень полезны.
Хотя любые отзывы очень важны, здесь приведены некоторые советы, которые помогут сделать их более полезными.
Используйте метки правильно
Когда вы отправляете сообщение о проблеме, так и когда вы отвечаете на сообщение о проблеме в качестве участника, правильное использование меток чрезвычайно полезно для координирования с другими участниками.
Попробуйте точно указать, тип сообщения: ошибка, запрос функции или предложение более общего плана на будущее. Вся эта информация представляет ценность, но она будет еще более ценной, если ее правильно обозначить.
Аналогично, если в текущей форме проблему нельзя решить, то применение соответствующей метки (например "неясно") может помочь сформулировать ее так, чтобы ее можно было решить. Конкретные комментарии в самом описании проблемы, конечно же, очень полезны. Но благодаря правильной метке другие смогут увидеть комментарий, который в противном случае не заметят.
Информирование об ошибке
Проблемы можно отправить на портале проблем на GitHub. Если вы потратите время на сообщение о проблеме или отправите предложение, которое будет полезно другим пользователям, другие это оценят очень положительно.
Каждый отчет об ошибке имеет свой собственный контекст, но в целом, чем больше из следующей информации будет включено, тем быстрее можно будет решить проблему.
Файлы журнала с устройства
Файлы журнала с устройства могут быть очень полезны при изучении проблем, особенно в сочетании со снимками экрана, которые предлагается добавить ниже. Их можно получить с помощью портала устройств Windows, подключенного к устройству, в разделе "Система" > "Проводник" > папка пользователя \ LocalAppData \ WorldLockingTools
Файл журнала приложения Unity
UnityPlayer.log находится в вложенной папке TempState. Это обычный текстовый файл.
Запись диагностики World Locking Tools
Файл диагностики находится во вложенной папке LocalState. Имя файла создается автоматически в соответствии со следующим шаблоном:
FrozenWorld-<device name>-<capture date and time>.hkfwЭто двоичный файл, для изучения которого требуется специальное программное обеспечение.
Обратите внимание, что для записи диагностики необходимо включить параметр Diagnostics Recording в компоненте World Locking Tools Manager в сцене. Дополнительные сведения см. в документации по диагностике.
Шаги для воспроизведения
Укажите, насколько часто возникает эта ошибка. В идеале ошибка должна происходить в 100 % случаев после определенного порядка действий. Но даже если ошибка была замечена только один раз, чем подробнее вы опишете действия, которые привели к ней, тем лучше.
Шаги для воспроизведения нужно указывать в следующем общем формате:
- Начиная с этого нормального стабильного состояния...
- Затем после таких действий (или было замечено это необычное поведение)...
- После этого система проявила это неверное поведение...
снимки экрана;
Записи экрана помогают определить полный контекст проблемы. В частности, на экране отображается диагностика World Locking Tools, которая может помочь сопоставить ваш опыт взаимодействия с информацией в журналах. Записями экрана могут быть либо как снимки экрана, таки и видеозаписи.
Сведения об устройстве
- Какой тип устройства?
- Какая версия ОС используется?
Среда сборки
- Версия Unity
- Версия Visual Studio
Как предложить функцию
Если вы обнаружите, что World Locking Tools делает почти то, что нужно, то существует вероятность того, что кто-то другой столкнулся с тем же ограничением. Мы так же заинтересованы в исправлении недочетов в нашей документации и примерах, как и в предоставлении новых возможностей.
При предложении новой функции важно понять, что именно вы пытаетесь сделать. Хотя идея о том, как реализовать ее, также может быть полезной, предложения, ценность которых более очевидна, с большей вероятностью получат отклик. Сделайте так, чтобы проблема, которую решает функция, была очевидной. Желательно указать пример с реальной ситуацией.
Не забудьте прикрепить метку "улучшение" к отправляемому предложению.
Код дополнения
Это проект с открытым кодом, поэтому любой пользователь может создать ветвь в любое время. Если кто-то предоставляет доступ к своей работе в отдельно ветви, это очень ценится, независимо от того, будет ли она включена в основной репозиторий или нет.
Во время первоначального периода развертывания ресурсы, доступные для рассмотрения и принятия запросов на включение изменений в основной репозиторий будут ограничены. Рекомендуется не тратить слишком много времени на ветвь, предполагая, что она будет добавлена в основной репозиторий.
Одним из способов снижения риска — сначала отправить предложение (с пометкой "улучшение"), прежде чем тратить много времени на реализацию. Это также является разумным по отношению к другим участникам, которые могут изучать ту же проблемную область.