Вклад в проект

Мы приветствуем вклад от всех участников! Любой вклад ценен.

Вот несколько советов для начала:

• Вы можете посмотреть на метку E-easy на трекере задач.
• Нужна помощь с упаковкой для различных дистрибутивов!
• Чтобы использовать печать отладки для файла журнала Helix, необходимо:
  • Выполнить печать с помощью log::info!, warn! или error!. (log::info!("helix!"))
  • Передать соответствующий уровень детализации для желаемого уровня журнала. (hx -v <файл> для информации, больше v для более высокого уровня детализации)
  • Хотите отобразить журналы в отдельном файле вместо использования команды :log-open в скомпилированном редакторе Helix? Запустите версию отладки с cargo run -- --log foo.log и в новом терминале используйте tail -f foo.log.
• Вместо запуска релизной версии Helix во время разработки вы можете захотеть запустить её в режиме отладки с помощью команды cargo run, которая компилируется намного быстрее.
• Ищете ещё более быстрое время компиляции? Попробуйте mold.
• Если ваш предпочитаемый язык отсутствует, интеграция грамматики tree-sitter для него и определение запросов подсветки синтаксиса для него просты и не требуют глубоких знаний внутренних компонентов.

Мы предоставляем файл architecture.md, который должен дать вам хорошее представление о внутренней структуре.

Автоматически генерируемая документация

Некоторые части книги docs автоматически генерируются из самого кода, например, список команд :commands и поддерживаемых языков. Чтобы создать эти файлы, выполните команду:

cargo xtask docgen

внутри проекта. Мы используем xtask в качестве специального средства запуска задач.

Чтобы просмотреть саму книгу, установите mdbook. Затем выполните команду:

mdbook serve book

и посетите [http://localhost:3000].

Тестирование

Модульные тесты / Тесты документации

Выполните команду cargo test --workspace, чтобы запустить модульные тесты и тесты документации во всех пакетах.

Интеграционные тесты

Интеграционные тесты для helix-term можно выполнить с помощью команды cargo integration-test. Участникам, вносящим свой код, настоятельно рекомендуется писать интеграционные тесты для своего кода. Существующие тесты можно использовать в качестве примеров. Помощники находятся в файле helpers.rs. Уровень журнала можно установить с помощью переменной среды HELIX_LOG_LEVEL, например, HELIX_LOG_LEVEL=debug cargo integration-test.

Политика минимальной стабильной версии Rust (MSRV)

Helix следует политике MSRV Firefox. Текущая версия MSRV и будущие изменения в MSRV перечислены в [документации Firefox].