Перейти к содержимому
Birchpad

Участие в проекте

Birchpad — проект с открытым кодом под лицензией MIT или Apache-2.0 на ваш выбор. Помочь можно по-разному:

  • Сообщить об ошибке или предложить идею — в Issues на GitHub. Укажите версию (? → О программе), систему и шаги, чтобы повторить ошибку.
  • Сообщить об уязвимости — не публично, а как описано в SECURITY.md.
  • Рассказать о Birchpad и поставить звезду на GitHub.
  • Улучшить этот сайт — исходники в birchpad-landing; на каждой странице документации есть ссылка «Редактировать страницу».

Код

Заголовок раздела «Код»

Перед чем-то крупнее небольшого исправления откройте issue или обсуждение, чтобы договориться о подходе. Архитектурные решения записаны в docs/adr; если изменение им противоречит, предложите новое решение.

Окно терминала
cargo fmt --all
cargo clippy --workspace --all-targets
cargo test --workspace

CI запускает то же самое с предупреждениями как ошибками на Windows (x64 и ARM64), Linux и macOS, плюс cargo-deny. Как собрать проект — в разделе Сборка из исходников.

  • Тесты обязательны. У проекта нет тестировщиков, поэтому тесты — его контроль качества: для каждого изменения — обычный сценарий, ошибочный ввод и граничные значения. Исправление ошибки приходит с тестом, который без исправления падает.
  • Коммиты — в стиле Conventional Commits (feat:, fix:, docs:…), один логический шаг на pull request.
  • Чужой код. Нельзя копировать код из проектов под GPL (включая Notepad++) и MPL. Читать их ради идей можно. Совместимость с форматами файлов Notepad++ (темы, UDL, API-файлы) приветствуется.

Полные правила — в CONTRIBUTING.md.