Вклад во Flipper

Мы хотим сделать вклад в этот проект максимально простым и прозрачным.

Процесс разработки

Изменения от сотрудников Facebook синхронизируются с репозиторием GitHub автоматически. PR от сообщества импортируются в нашу внутреннюю систему контроля версий, а затем отправляются на GitHub.

Для изменений, влияющих как на нативный код, так и на JavaScript, убедитесь, что вы создаёте только один PR, содержащий обе части кода.

Хотя настольное приложение Flipper сейчас выпущено только для macOS, можно создавать сборки приложения для Windows и Linux. Пожалуйста, имейте это в виду при работе с платформозависимым кодом.

Запросы на вытягивание (Pull Requests)

Мы активно приветствуем ваши запросы на вытягивание.

1. Форкните репозиторий и создайте свою ветку из main.
2. Если вы добавили код, который должен быть протестирован, добавьте тесты.
3. Если вы изменили API, обновите документацию.
4. Убедитесь, что тестовый набор проходит успешно.
5. Убедитесь, что ваш код соответствует стандартам линтинга.
6. Если вы ещё этого не сделали, заполните Лицензионное соглашение участника («CLA»).

Проверка изменений во Flipper

После открытия запроса на вытягивание или отправки изменений в ветку, CI создаст для вас артефакты сборки для Linux, MacOS и Windows. Вы можете скачать их из проверок GitHub Actions вашего запроса на вытягивание.

Лицензионное соглашение участника (CLA)

Чтобы мы могли принять ваш запрос на вытягивание, нам нужно, чтобы вы представили CLA. Вам нужно сделать это только один раз, чтобы работать над любым из проектов с открытым исходным кодом Facebook.

Заполните своё CLA здесь: https://code.facebook.com/cla

Проблемы

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

У Facebook есть программа вознаграждений за безопасное раскрытие ошибок безопасности. В этих случаях, пожалуйста, пройдите процесс, описанный на этой странице, и не создавайте публичную проблему.

Стиль кодирования

Мы используем Prettier для форматирования нашего исходного кода. Стили применяются через eslint. Перед созданием PR убедитесь, что всё хорошо отформатировано. Поэтому запустите yarn lint и yarn fix, чтобы применить исправления форматирования.

Лицензия

Внося свой вклад во Flipper, вы соглашаетесь с тем, что ваши вклады будут лицензированы в соответствии с файлом LICENSE.