Вклад в Electron

Доступные переводы: корейский | упрощённый китайский | бразильский португальский | голландский

:+1::tada: Сначала, спасибо за то, что уделили время для вклада! :tada::+1:

Этот проект следует кодексу поведения Contributor Covenant. Участвуя, вы обязаны соблюдать этот код. Пожалуйста, сообщите о недопустимом поведении на atom@github.com.

Ниже приведены руководства по вкладу в проект Electron. Это только руководства, а не правила, используйте своё лучшее суждение и не стесняйтесь предлагать изменения в этом документе в виде pull request.

Подача проблем* Вы можете создать проблему здесь,

но перед этим, пожалуйста, прочитайте примечания ниже и включите в свой отчёт как можно больше деталей. Если возможно, включите:

• Версию Electron, которую вы используете

• Операционную систему, которую вы используете

• Если применимо, то, что вы делали, когда возникла проблема, и что вы ожидали увидеть

• Другие вещи, которые помогут решить вашу проблему:

  • Скриншоты и анимированные GIF-изображения
  • Вывод ошибок, который появляется в вашем терминале, инструментах разработчика или как уведомление
  • Выполните краткий поиск чтобы убедиться, что подобная проблема не была уже подана## Подача pull request

• Включите скриншоты и анимированные GIF-изображения в ваш pull request, когда это возможно.

• Следуйте стилю кодирования, определённому в документации для JavaScript, C++ и Python.

• Пишите документацию в Markdown. См. руководство по стилю документации.

• Используйте краткие, настоящие формы глаголов сообщения о коммитах. См. руководство по стилю сообщений о коммитах Git.

Руководства по стилю

Общий код

• Заканчивайте файлы новой строкой.
• Располагайте requires в следующем порядке:
  • Встроенные модули Node.js (например, path)
  • Встроенные модули Electron (например, ipc, app)
  • Локальные модули (используя относительные пути)
• Располагайте свойства класса в следующем порядке:
  • Методы и свойства класса (методы, начинающиеся с @)
  • Методы и свойства экземпляра
• Избегайте кода, зависящего от платформы:
  • Используйте path.join() для конкатенации имен файлов.
  • Используйте os.tmpdir() вместо /tmp, когда вам нужно сослаться на временную директорию.
• Используйте простое return при явном возврате в конце функции.
  • Не используйте return null, return undefined, null или undefined

Правила для сообщений о коммитах в Git* Используйте настоящее время ("Добавить функцию" а не "Добавлено функцию")

• Используйте повелительное наклонение ("Переместить курсор к..." а не "Перемещает курсор к...")
• Ограничьте первую строку 72 символами или меньше
• Ссылаясь на задачи и запросы на слияние, используйте их обильно
• Когда меняете только документацию, включите [ci skip] в описание коммита
• Рассмотрите возможность начала сообщения о коммите подходящим эмодзи:
  • :art: при улучшении формата/структуры кода
  • :racehorse: при улучшении производительности
  • :non-potable_water: при устранении утечек памяти
  • :memo: при написании документации
  • :penguin: при исправлении чего-либо на Linux
  • :apple: при исправлении чего-либо на macOS
  • :checkered_flag: при исправлении чего-либо на Windows
  • :bug: при исправлении ошибки
  • :fire: при удалении кода или файлов
  • :green_heart: при исправлении сборки CI
  • :white_check_mark: при добавлении тестов
  • :lock: при работе с безопасностью
  • :arrow_up: при обновлении зависимостей
  • :arrow_down: при понижении версий зависимостей
  • :shirt: при удалении предупреждений линтера