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

Вклад кода через GitHub

Мы используем Git для контроля версий. Если вы хотите внести вклад в openBSE, вам необходимо ознакомиться с основными методами использования Git. В настоящее время этот проект размещается на GitHub, поэтому перед внесением кода вам потребуется создать учётную запись на этой платформе.

Процесс внесения кода очень прост:

• fork код в свой репозиторий;
• внесите свой код;
• отправьте запрос на включение (pull request), подробно описав внесённые изменения. Мы оперативно обработаем вашу заявку и проверим ваш код. После проверки код будет объединён (merge) с нашим репозиторием;
• после выполнения этих действий вы автоматически будете включены в список участников проекта.

Мы ожидаем, что ваш код будет соответствовать следующим требованиям:

• код должен быть снабжён соответствующими комментариями, чтобы другие участники могли понять его;
• код должен соответствовать стандартам и быть хорошо отформатирован;
• при отправке кода необходимо соблюдать условия лицензии MIT. Если ваш код имеет новые зависимости, убедитесь, что их лицензии не конфликтуют с лицензией MIT.

GitHub Issue

Мы используем функцию Issues, предоставляемую GitHub, для:

• сообщения об ошибках;
• предложения улучшений функций;
• предложений по дополнению документации;
• обратной связи о пользовательском опыте.

Эта функция не должна использоваться для:

• выражения мнений о внесении изменений (включая вопросы авторских прав и отслеживания изменений);
• публикации недружелюбных высказываний;
• распространения клеветы или оскорблений в адрес других людей;
• высказываний, содержащих расовые, гендерные или географические предубеждения;
• пропаганды насилия и терроризма;
• обсуждения любых политических тем;
• дискуссий на темы, связанные с порнографией;
• любых других высказываний, которые могут нанести вред общественным интересам или оскорбить других людей.

Быстрое редактирование

Этот метод подходит для небольших изменений в коде

• Войдите в свою учётную запись GitHub;
• Просмотрите файлы проекта и найдите файл, который нужно изменить;
• Нажмите на значок карандаша в правом верхнем углу, чтобы внести изменения;
• Заполните поле «Commit changes» (поле «Title» обязательно); Отправьте изменения на проверку и объединение.

Масштабное редактирование

Если вам нужно внести значительные изменения или добавить новый код, выполните следующие действия:

• fork проект;
• Клонируйте (clone) свой fork-проект на локальный компьютер;
• Создайте новую ветку (branch) и переключитесь на неё (checkout);
• Добавьте этот проект в свой локальный репозиторий Git как вышестоящий (upstream);
• Внесите изменения;
• Перебазируйте (rebase) свою ветку на основную ветку (master);
• Отправьте (push) свой локальный репозиторий на GitHub;
• Отправьте запрос на включение (pull request);
• Дождитесь проверки и своевременно перебазируйте свою ветку на основную (master) ветку, если в ней были внесены изменения.

*При необходимости можно использовать git push -f для принудительной отправки ветки после rebase в свой fork*

Категорически запрещено использовать git push -f для принудительного внесения изменений в вышестоящую ветку

Рекомендуемая среда разработки

• Node.js (npm)
• Visual Studio Code
• GIT GUI (SourceTree, GitHub Desktop)