Настройка

1. Скачайте и установите Visual Studio Community 2017. Во время установки убедитесь, что установлен флажок «Разработка настольных приложений .NET».

2. Скачайте и установите Git. Во время установки измените «Использовать Git из Git Bash только» на один из двух других вариантов в зависимости от ваших предпочтений.

3. Клонируйте репозиторий, открыв командную строку / PowerShell в выбранной папке и набрав git clone https://github.com/HearthSim/Hearthstone-Deck-Tracker.

4. Загрузите рекомендуемый последний исполняемый файл nuget и скопируйте его в свой PATH или туда, где вы клонировали репозиторий git (где находится bootstrap.ps1).

5. Запустите bootstrap.ps1, предпочтительно из окна PowerShell, чтобы увидеть ошибки.

6. Откройте файл решения с помощью VS17 и выполните сборку, чтобы убедиться, что всё работает правильно.

Создание проблем

• Ознакомьтесь с FAQ.
• Проверьте, не существует ли уже подобной проблемы (используйте функцию поиска).
• В случае ошибки / сбоя / проблемы: добавьте как можно больше деталей, включая отчёты о сбоях / журналы (см. здесь).

Вклад

Соглашение о лицензии участника

HearthSim требует подписанного CLA от любого участника перед тем, как его PR может быть объединён.

Что такое CLA?

CLA — это юридический документ, в котором вы заявляете, что имеете право вносить код / документацию / перевод в проект, в который вы вносите свой вклад, и готовы использовать его в дистрибутивах и производных работах. Это означает, что в случае возникновения в будущем каких-либо юридических вопросов относительно происхождения и владения каким-либо конкретным фрагментом кода, у этого проекта есть необходимые формы от участника(ов), подтверждающие, что им было разрешено внести этот вклад.

CLA также гарантирует, что после того, как вы внесли свой вклад, вы не сможете попытаться отозвать разрешение на его использование в дальнейшем. Таким образом, люди и компании могут использовать это программное обеспечение, будучи уверенными, что их не попросят прекратить использование частей кода позже.

• Тони Гантарп (CLAHub)

Почему?

HearthSim использует соглашение о лицензии участника, чтобы гарантировать, что мы можем законно использовать, распространять и повторно лицензировать внешние вклады в наши различные проекты.

Как мне его подписать?

Свяжитесь с любым администратором на нашем Developer Discord или отправьте нам электронное письмо по адресу contact@hearthsim.net. Пожалуйста, укажите свой Github username.

Утверждение проекта

Для тривиальных изменений или исправлений (например, пара строк кода) в новых или существующих проблемах и проектах не стесняйтесь просто открыть PR.

Мы хотели бы избежать траты вашего времени, поэтому для нетривиальных изменений или исправлений, пожалуйста, сделайте одно из следующих действий перед началом работы над ним:

• Для работы над существующей проблемой прокомментируйте эту проблему и дождитесь одобрения.
• Если проблема не существует, откройте новую проблему с предложением и дождитесь одобрения.
• Предложите проект в #hdt на Developer Discord и дождитесь одобрения.

Стиль кодирования

1. Всегда используйте вкладки.
2. Используйте окончания строк LF.
3. Всегда размещайте фигурные скобки на новых строках.
4. Используйте синтаксис C# 6/C# 7 везде, где это возможно.
5. Следуйте стандартным соглашениям об именах MS C# (краткая версия). Также см.: Как называть вещи в программировании
6. Знайте, когда нужно делать исключения.

Фиксации и запросы на вытягивание

Поддерживайте журнал фиксации в таком же хорошем состоянии, как и код. Это одно из первых мест, куда новые участники обратятся при изучении проекта.

1. Не более одного изменения на фиксацию. В фиксации не должно быть изменений, не связанных с её сообщением.
2. Следуйте этим При написании сообщения коммита придерживайтесь принятых соглашений.
3. Старайтесь, чтобы изменения в коде были как можно более чистыми. Избегайте лишних изменений строк.

При отправке Pull Request убедитесь, что он перебазирован поверх последнего мастера. Если вам нужно изменить или дополнить его каким-либо образом, вы всегда должны соответствующим образом исправлять проблемы в git и принудительно отправлять свои изменения в свой форк.

Также см.: Помощь Github: Использование запросов на вытягивание.

Переводы

Хотите помочь перевести приложение? Взгляните на репозиторий HDT-Localization.

Нужна помощь?

Вы всегда можете обратиться за помощью на Gitter, #hdt в Developer Discord или в IRC-канал HearthSim, #Hearthsim на Freenode.