Вклад в CodeEdit

Приглашаем присоединиться и сотрудничать на нашем Discord-сервере.

[!ВНИМАНИЕ] На данный момент не отправляйте запросы на включение изменений, связанных с локализацией. Как только мы будем готовы поддерживать больше языков, мы сообщим вам об этом и предоставим руководство о том, как внести свой вклад здесь и на нашем Discord Server.

Форк и клонирование CodeEdit

Нажмите кнопку «Форк» в верхней части сайта. После форка клонируйте разветвлённый репозиторий на свой Mac.

Изучение проблем

Найдите проблемы на вкладке Issues или в столбце To Do нашего проекта. Если вы нашли проблему, над которой хотите поработать, пожалуйста, укажите её в проблеме и/или прикрепите черновик PR, когда он будет доступен. Администратор или сопровождающий затем назначит проблему и/или PR вам.

[!ВАЖНО] Пожалуйста, сначала прокомментируйте проблему или попросите сопровождающего назначить вас на проблему, прежде чем работать над ней. Это помогает предотвратить работу нескольких человек над одним и тем же, что может привести к тому, что ваша работа не будет объединена. Кроме того, некоторые проблемы могут быть зарезервированы для тех, кто имеет более глубокие знания кодовой базы.

Начало работы

Пожалуйста, ознакомьтесь с руководством Начало работы в нашей вики.

У нас также есть руководство по устранению неполадок, которое содержит общие решения.

Стиль кода

Ознакомьтесь с нашим руководством по Стилю кода в нашей вики.

Запрос на включение изменений (Pull Request)

Как только вы будете довольны изменениями, отправьте запрос на включение изменений (Pull Request).

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

PR должен включать следующую информацию:

• Описательный заголовок о том, что изменилось.
• Подробное описание изменений.
• Если вы внесли изменения в пользовательский интерфейс, добавьте скриншот или видео.
• Если есть связанная проблема, добавьте ссылку на проблему. Если нет, создайте её заранее и свяжите.
• Если ваш PR всё ещё находится в разработке, пометьте его как черновик.

Проверки, тесты и документация

Запросите проверку у одного из наших администраторов @austincondiff, @lukepistrol, @MarcoCarnevali, @jasonplatts, @pkasila или сопровождающих @cstef, @linusS1, @RayZhao1998, @wdg.

[!СОВЕТ] Если это ваш первый PR, администратору необходимо запросить проверку для вас.

[!ВАЖНО] Устраните все ошибки Violation в Xcode (кроме предупреждений TODO:). В противном случае проверка SwiftLint на GitHub завершится неудачно.

После отправки PR GitHub выполнит несколько действий, которые запускают тесты и SwiftLint (это может занять пару минут). Если тест не пройден, он не может быть объединён до тех пор, пока тесты не пройдут успешно.

Убедитесь, что разрешены все конфликты слияния, иначе PR не может быть объединён.

[!ВАЖНО] Убедитесь, что ваш код хорошо документирован, чтобы другие могли легко взаимодействовать с вашим кодом!