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

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

После клонирования и сборки кодовой базы, пожалуйста, ознакомьтесь с списком проблем. Если вы впервые используете LCFinder, то можете посмотреть на проблемы, помеченные как good first issue.

Сборка и запуск

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

Получение исходного кода

git clone https://github.com/lc-soft/LC-Finder.git

Предварительные условия

• Git
• NodeJS
• C/C++ компилятор:
  • Windows:
    • Visual Studio 2017 Community Edition, убедитесь, что выбраны все инструменты C++ и Windows SDK.
  • Linux:
    • xmake
    • GCC или другой компилятор
• Библиотеки зависимостей:
  • LCUI
  • LCUI.css
  • sqlite3
  • unqlite или leveldb
  • libyaml
  • darknetlib

Наконец, выполните следующую команду для установки всех зависимостей:

cd LC-Finder
./setup.sh

Скрипт setup.sh скачает необходимые инструменты и зависимости для сборки LCFinder. Его нужно выполнить только один раз.

Для пользователей Windows рекомендуется использовать vcpkg для установки зависимостей, команда выглядит следующим образом:

.\vcpkg install libyaml sqlite3 leveldb

Сборка

Windows

Откройте файл LC-Finder.sln с помощью VisualStudio, затем выберите «Построить → Построить решение» в меню панели инструментов.

Linux

Выполните следующую команду:

./build.sh

Запуск

Перейдите в каталог приложения и запустите файл LC-Finder.

Структура каталогов

UWP            针对 UWP 平台的相关源代码及文件
app              应用程序目录
  assets          应用程序资源文件
    views          视图描述文件
    stylesheets     界面样式
      fonts         字体文件
  locales          用于本地化的语言翻译文件
config             相关配置
include            头文件
src                 源代码
  lib               基础功能库
    scss            SCSS 文件，包含用户界面相关的样式
      common         通用样式
      components      组件样式
      views           视图样式
  ui                 用户界面
    views            视图控制器
    components        界面组件
vendor              第三方依赖库

Запросы на вытягивание

Чтобы мы могли быстро рассмотреть и принять ваш запрос на вытягивание, всегда создавайте отдельный запрос для каждой проблемы и связывайте его с этой проблемой. Не объединяйте несколько запросов в один, если у них нет общей основной причины. Обязательно следуйте нашим стандартам кодирования и минимизируйте изменения в коде. Запрос на вытягивание должен включать тестовые случаи, где это возможно.

С чего начать вносить вклад

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

• Пользовательский опыт — если вы недовольны существующим графическим интерфейсом, например, не нравится стиль интерфейса, неудобно работать и т. д., сначала оставьте отзыв о проблеме, предоставьте общее улучшение и убедительные аргументы, чтобы мы определили, требуется ли изменение.
• Архитектура — если ваше изменение затрагивает архитектуру, сначала получите согласие автора.

Чтобы увеличить шансы на объединение запроса на вытягивание, вы должны выбрать проблемы, отмеченные help-wanted или bug. Если проблема не имеет этих меток, вы можете связаться с создателем проблемы и спросить, будет ли он рассматривать внешние вклады.

Перевод

Мы используем файлы перевода в формате yaml, которые хранятся в каталоге app/locales. Если вы хотите добавить переводы на другие языки, вы можете обратиться к содержимому файла en-us.yaml для добавления текста перевода.