Участник:Richard Jones: различия между версиями
(не показано 16 промежуточных версий этого же участника) | |||
Строка 1: | Строка 1: | ||
Здесь вы найдете краткое руководство, кто хочет освоить маппинг, но не имеет ни малейшего представления, с чего начать. | |||
Сам процесс маппинга очень прост - сложность составляет, скорее, знание билда и кода. Однако, вам, как мапперу, очень важно следовать простому, но правильному и удобному рабочему процессу. “Просто возьми ZIP-файл и работай в нем!” - такое нам не подойдет. Устраивайтесь поудобнее, сделайте себе чаю и слушайте внимательно. | |||
== | ==Что нам понадобится== | ||
Возможно, этот список покажется вам слишком длинным и трудоемким, но здесь указаны самые простые и современные программы. Вы не ошибетесь, выбрав их. | |||
* [https://git-scm.com/downloads Git] - нам не избежать его использования. | |||
* [https://github.com/apps/desktop Github Desktop] - Вы можете использовать любой Git-клиент, которым вы уже умеете пользоваться (Bash или GitKraken). Но не забудьте создать на аккаунт на гитхабе. | |||
* [https://github.com/SpaiR/StrongDMM StrongDMM] - лучший редактор карт за авторством нашего любимого SpaiR. Доступен для Windows, Linux, и MacOS. Никогда, слышите, НИКОГДА не используйте Dream Maker для маппинга. Вы только навредите себе и уничтожите любое желание маппить, которое могло у вас остаться. | |||
* [https://code.visualstudio.com/ Visual Studio Code] - это опционально, но очень рекомендуется, потому что вам потребуется тестировать свои изменения на локальном сервере, а также иногда трогать код. | |||
==Git ready to suffer== | |||
В этой главе описан способ вносить в билд свои изменения с помощью Github Desktop, но если вам больше по душе консольный гит - вы можете прочитать [[Git/Git-console|этот гайд]], пропустить данную главу и сразу перейдя в [[Guide to Mapping#Устанавливаем хуки|следующую]]. | |||
Итак, начнем. Во-первых, вам понадобится [https://git-scm.com/book/ru/v2/GitHub-%d0%92%d0%bd%d0%b5%d1%81%d0%b5%d0%bd%d0%b8%d0%b5-%d1%81%d0%be%d0%b1%d1%81%d1%82%d0%b2%d0%b5%d0%bd%d0%bd%d0%be%d0%b3%d0%be-%d0%b2%d0%ba%d0%bb%d0%b0%d0%b4%d0%b0-%d0%b2-%d0%bf%d1%80%d0%be%d0%b5%d0%ba%d1%82%d1%8b форк]. Форк будет вашей собственной копией нашего репозитория, с которой вы можете делать все, что пожелаете! Просто нажмите эту кнопку на https://github.com/TauCetiStation/TauCetiClassic: | |||
[[Файл:How to fork.png|безрамки|586x586пкс]] | |||
Как только вы его сделаете, у вас должно появиться что-то подобное в вашем базовом профиле на GitHub.: | |||
[[Файл:How to fork2.png|безрамки]] | |||
Отлично! Итак, я надеюсь, вы уже скачали [https://github.com/apps/desktop Github Desktop]? Следующая часть будет простой: нажмите эту удобную кнопку под “Code” прямо здесь: | |||
[[Файл:How to fork3.png|безрамки]] | |||
Вы увидите экран, который выглядит примерно так. Просто убедитесь, что у вас есть чистая папка, в которую Git сможет клонировать себя, и нажмите “Clone”: | |||
[[Файл:How to fork4.png|безрамки]] | |||
Итак, на следующем экране вам нужно нажать “Contribute to the parent project”. Это важно, потому что это немного облегчит вашу жизнь на последующих этапах (На этапе Пул Реквеста): | |||
[[Файл:How to fork5.png|безрамки]] | |||
Круто, теперь у вас есть копия нашего билда! Однако, прежде чем делать какие-либо изменения, вам нужно сделать одну важную вещь: | |||
[[Файл:How to fork6.png|безрамки]] | |||
Создать новую ветку! Это супер важно, потому что нам нужно, чтобы главная “master” ветка на вашем форке была как можно более "чистой", без ваших изменений. Для каждого отдельного проекта, над которым вы работаете и для которого отправляете запрос на обновление, вы создадите отдельную ветку. Не стесняйтесь называть ее как хотите! В конце концов, это ваша ветка. | |||
[[Файл:How to fork7.png|безрамки]] | |||
Вы также можете увидеть экран с надписью “base it off the current branch” или “base it off the upstream/master”. Это зависит от того, чего вы хотите, но если вы хотите начать новый ПР с чистого листа, всегда нажимайте “base it off the upstream/master”. | |||
[[Файл:How to fork8.png|безрамки|403x403пкс]] | |||
Вот, как все должно выглядеть. Вы отлично справляетесь, так держать! | |||
== Устанавливаем хуки == | |||
'''Этот шаг очень важен!''' | |||
Наш репозиторий довольно большой, и в нем одновременно работают большое количество людей, над большим количеством проектов, зачастую на одних и тех же файлах одновременно. Как следствие, в файлах могут возникать конфликты. Но у нас есть отличный набор инструментов, которые помогут нам справиться с этими конфликтами, и установка этих Git-хуков на данный момент - одна из лучших вещей, которые вы можете сделать. | |||
Во-первых, в корневом каталоге вашего репозитория перейдите в <code>/tools/_git-hooks</code> и запустите <code>_install.sh</code>. Это автоматически настроит ваши Git-хуки, что избавит вас от многих трудностей. Этот хук будет "объединять" ваши изменения, когда вы редактируете карты. Удостоверьтесь, также, что у вас стоит Java, она нужна для хуков. |
Версия 20:20, 9 мая 2025
Здесь вы найдете краткое руководство, кто хочет освоить маппинг, но не имеет ни малейшего представления, с чего начать.
Сам процесс маппинга очень прост - сложность составляет, скорее, знание билда и кода. Однако, вам, как мапперу, очень важно следовать простому, но правильному и удобному рабочему процессу. “Просто возьми ZIP-файл и работай в нем!” - такое нам не подойдет. Устраивайтесь поудобнее, сделайте себе чаю и слушайте внимательно.
Что нам понадобится
Возможно, этот список покажется вам слишком длинным и трудоемким, но здесь указаны самые простые и современные программы. Вы не ошибетесь, выбрав их.
- Git - нам не избежать его использования.
- Github Desktop - Вы можете использовать любой Git-клиент, которым вы уже умеете пользоваться (Bash или GitKraken). Но не забудьте создать на аккаунт на гитхабе.
- StrongDMM - лучший редактор карт за авторством нашего любимого SpaiR. Доступен для Windows, Linux, и MacOS. Никогда, слышите, НИКОГДА не используйте Dream Maker для маппинга. Вы только навредите себе и уничтожите любое желание маппить, которое могло у вас остаться.
- Visual Studio Code - это опционально, но очень рекомендуется, потому что вам потребуется тестировать свои изменения на локальном сервере, а также иногда трогать код.
Git ready to suffer
В этой главе описан способ вносить в билд свои изменения с помощью Github Desktop, но если вам больше по душе консольный гит - вы можете прочитать этот гайд, пропустить данную главу и сразу перейдя в следующую.
Итак, начнем. Во-первых, вам понадобится форк. Форк будет вашей собственной копией нашего репозитория, с которой вы можете делать все, что пожелаете! Просто нажмите эту кнопку на https://github.com/TauCetiStation/TauCetiClassic:
Как только вы его сделаете, у вас должно появиться что-то подобное в вашем базовом профиле на GitHub.:
Отлично! Итак, я надеюсь, вы уже скачали Github Desktop? Следующая часть будет простой: нажмите эту удобную кнопку под “Code” прямо здесь:
Вы увидите экран, который выглядит примерно так. Просто убедитесь, что у вас есть чистая папка, в которую Git сможет клонировать себя, и нажмите “Clone”:
Итак, на следующем экране вам нужно нажать “Contribute to the parent project”. Это важно, потому что это немного облегчит вашу жизнь на последующих этапах (На этапе Пул Реквеста):
Круто, теперь у вас есть копия нашего билда! Однако, прежде чем делать какие-либо изменения, вам нужно сделать одну важную вещь:
Создать новую ветку! Это супер важно, потому что нам нужно, чтобы главная “master” ветка на вашем форке была как можно более "чистой", без ваших изменений. Для каждого отдельного проекта, над которым вы работаете и для которого отправляете запрос на обновление, вы создадите отдельную ветку. Не стесняйтесь называть ее как хотите! В конце концов, это ваша ветка.
Вы также можете увидеть экран с надписью “base it off the current branch” или “base it off the upstream/master”. Это зависит от того, чего вы хотите, но если вы хотите начать новый ПР с чистого листа, всегда нажимайте “base it off the upstream/master”.
Вот, как все должно выглядеть. Вы отлично справляетесь, так держать!
Устанавливаем хуки
Этот шаг очень важен!
Наш репозиторий довольно большой, и в нем одновременно работают большое количество людей, над большим количеством проектов, зачастую на одних и тех же файлах одновременно. Как следствие, в файлах могут возникать конфликты. Но у нас есть отличный набор инструментов, которые помогут нам справиться с этими конфликтами, и установка этих Git-хуков на данный момент - одна из лучших вещей, которые вы можете сделать.
Во-первых, в корневом каталоге вашего репозитория перейдите в /tools/_git-hooks
и запустите _install.sh
. Это автоматически настроит ваши Git-хуки, что избавит вас от многих трудностей. Этот хук будет "объединять" ваши изменения, когда вы редактируете карты. Удостоверьтесь, также, что у вас стоит Java, она нужна для хуков.