Как внести свой вклад

• Получение помощи
• Отправка отчётов об ошибках
• Внесение кода

Получение помощи

Обсуждения в сообществе, вопросы и неформальные отчёты об ошибках ведутся на форуме discuss.CodeMirror.

Отправка отчётов об ошибках

Предпочтительный способ сообщить об ошибке — использовать систему отслеживания ошибок GitHub. Прежде чем сообщать об ошибке, ознакомьтесь с этими указаниями.

Примечание: система отслеживания ошибок предназначена для ошибок, а не запросов о помощи. Вопросы следует задавать на форуме discuss.CodeMirror вместо этого.

Эффективное сообщение об ошибках

• CodeMirror поддерживается добровольцами. Они вам ничего не должны, поэтому будьте вежливы. Отчёты с возмущённым или агрессивным тоном обычно перемещаются в конец списка.

• Укажите информацию о браузере, в котором возникла проблема. Даже если вы тестировали несколько браузеров, и проблема возникла во всех из них, укажите этот факт в отчёте об ошибке. Также укажите номера версий браузера и операционную систему, которую вы используете.

• Упомяните, какую версию CodeMirror вы используете. Желательно также попробовать с текущим снимком разработки, чтобы убедиться, что проблема уже не была исправлена.

• Подробно опишите, что пошло не так. «X не работает» — это плохой отчёт об ошибке. Что должно было произойти? Что произошло вместо этого? Опишите точные шаги, которые должен предпринять сопровождающий, чтобы проблема возникла. Мы не можем исправить то, чего не видим.

• Если проблему нельзя воспроизвести ни в одной из демонстраций, включённых в дистрибутив CodeMirror, предоставьте HTML-документ, демонстрирующий проблему. Лучший способ сделать это — перейти на сайт jsbin.com, ввести его там, нажать «Сохранить» и включить полученную ссылку в отчёт об ошибке.

Внесение кода

Обратите внимание, что мы не принимаем новые дополнения или режимы в основной дистрибутив. Если вы написали такой модуль, пожалуйста, распространяйте его как отдельный пакет NPM.

• Убедитесь, что у вас есть учётная запись GitHub.
• Создайте форк CodeMirror (как создать форк репозитория).
• Внесите изменения.
• Если ваши изменения легко проверить или они могут привести к регрессу, добавьте тесты. Тесты для ядра идут в test/test.js, некоторые режимы имеют собственный набор тестов в mode/XXX/test.js. Не стесняйтесь добавлять новые наборы тестов для режимов, у которых их ещё нет (обязательно свяжите новые тесты с test/index.html).
• Следуйте общему стилю кода остальной части проекта (см. ниже). Запустите bin/lint, чтобы убедиться, что линтер доволен.
• Убедитесь, что все тесты пройдены. Посетите test/index.html в браузере, чтобы запустить их.
• Отправьте запрос на вытягивание (как создать запрос на вытягивание). Не помещайте более одного исправления или функции в один запрос на вытягивание.

Внося код в CodeMirror, вы

• соглашаетесь лицензировать внесённый код под лицензией MIT CodeMirror.

• подтверждаете, что имеете право вносить свой вклад и лицензировать соответствующий код. (Либо вы владеете всеми правами на код, либо владелец прав явно предоставил право использовать его таким образом через совместимую лицензию с открытым исходным кодом или через прямое соглашение с вами.)

Стандарты кодирования

• 2 пробела на уровень отступа, без табуляции.

• Обратите внимание, что линтёр (bin/lint), который запускается после каждого коммита, жалуется на неиспользуемые переменные и функции. Чтобы отключить предупреждение, префикс их имён с символом подчёркивания.

• CodeMirror не следует рекомендациям JSHint или JSLint. Патчи, пытающиеся «исправить» код для прохождения одного из этих линтеров, будут бесцеремонно отклонены.