Разработка
Поддержкой Haml занимаюсь я, Norman Clarke, и я очень признателен за любую помощь, которую я могу получить. Официальный репозиторий Haml на GitHubа большинство обсуждений по разработке происходит в ленте подписчиков на Haml.
Ошибки и Возможности
Если вы нашли ошибку в Haml или у вас есть что-то, что вы бы хотели увидеть в языке - сообщайте любыми способами! Создайте сообщение в трекер ошибок и я попытаюсь проследить за ним как смогу. Пожалуйста, проследите за тем, чтобы ваше сообщение содержало в себе:
- Какую версию Haml вы ипользуете (запустите
haml --version
в командной строке) - Если проблема касается Rails, то укажите версию Rails, которую вы используете (
rails --version
) - Если возможно, то небольшой шаблон в Haml с содержанием ошибки, предпочтительнее один, чтобы его можно было запустить с помощью команды
haml
в командной строке.
Как можно больше предоставляйте информации для максимально быстрого устранения ошибки!
Сотрудничество
Тогда как сообщения об ошибках и предложения улучшений это круто, то реальное исправление ошибок в коде или реализация улучшений в разы лучше. Если у вас наработки кода, которыми вы хотите посодействовать развитию, то сначала почитайте информацию ниже, потом сделайте форк репозитория Haml и пришлите пул реквест. Я проверю код вашего реквеста и после этого есть шанс, что я их введу в ветку разработки.
Haml имеет две основных ветки. Stable - в этой ветке развивается текущая версия Haml. Также в эту ветку направляется большинство сообщений об ошибках. Master - ветка, в которой разрабатывает следующая версия Haml и это место для новых возможностей. Пожалуйста, выбирайте подходящую ветку для ваших изменений.
Когда делаете патч, пожалуйста:
- Вы должны быть уверены, что ваш коммит содержит правильную пунктуацию и написан без чрезмерного использования заглавных букв
- Вы должны быть уверены, что сообщение коммита (краткое) является законченным предложением.
- Добавьте unit-тесты
- Добавьте запись в лог (
CHANGELOG.md
), описывающую ваши изменения. Не стесняйтесь добавлять(спасибо [Ваше имя](Ваш сайт))
в конец записи - Вы должны быть уверены, что ваши коммиты не добавляют новых пробелов (используйте
git diff --check
) - Если вы реализовали видимые для пользователей изменения, добавьте их описание в справку (
REFERENCE.md
)