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

Привет! Спасибо за ваш интерес к участию в этом проекте!

Чтобы поощрить активное сотрудничество, настоятельно рекомендуется отправлять пул реквесты, а не только отчёты об ошибках. Отчёты об ошибках также можно отправлять в виде пул реквеста, содержащего неудачный тест. Я также хотел бы услышать о идеях для новых функций в виде проблем.

Пожалуйста, сделайте следующее:

• Проверьте существующие проблемы, чтобы убедиться, что ошибка или запрос функции ещё не были отправлены.
• Откройте проблему, если что-то работает не так, как ожидалось.
• Откройте вопрос, чтобы предложить значительное изменение.
• откройте вопрос, чтобы предложить функцию
• Откройте пул реквест, чтобы исправить ошибку.
• Откройте пул реквест, чтобы исправить документацию о команде.
• Откройте пул реквест для проблемы с меткой «требуется помощь» и оставьте комментарий, заявляющий об этом.

Избегайте следующего:

• Открывать пул реквесты для проблем, помеченных как «нужен дизайн», «нужно расследование», «нужен ввод данных пользователем» или «заблокировано».
• Открытия пул реквестов для документации по новой команде специально. Страницы руководства автоматически генерируются из источника после каждого выпуска.

Сборка проекта

Предварительные условия: — Go 1.16+

Сборка с помощью: make или go build -o bin/glab ./cmd/glab/main.go

Запустите новый двоичный файл как: ./bin/glab

Запуск тестов с: make test или go test ./...

ВНИМАНИЕ: Не запускайте make test вне изолированной среды, это перезапишет вашу глобальную конфигурацию.

Отправка пул реквеста

1. Создайте новую ветку: git checkout -b my-branch-name
2. Внесите изменения, добавьте тесты и убедитесь, что тесты проходят
3. Отправьте пул реквест

Сообщения коммитов

TL;DR: Ваше сообщение коммита должно быть семантическим

Сообщение коммита состоит из заголовка, тела и нижнего колонтитула, разделённых пустой строкой.

Любая строка сообщения коммита не может быть длиннее 100 символов! Это позволяет сообщению легче читаться на GitHub, а также в различных инструментах git.

<type>[optional scope]: <description>
<BLANK LINE>
[optional body]
<BLANK LINE>
<footer>

Заголовок сообщения

В идеале заголовок сообщения коммита, содержащий описание, не должен превышать 50 символов.

Заголовок сообщения — это одна строка, содержащая краткое описание изменения, включающее тип, необязательную область действия и тему.

<type>

Описывает тип изменения, которое предоставляет этот коммит.

• feat (функция)
• fix (исправление ошибки)
• docs (документация)
• style (форматирование, пропущенные точки с запятой и т. д.)
• refactor(реструктуризация кодовой базы)
• test (при добавлении недостающих тестов)
• chore (поддержка)

<scope>

Область действия может быть любой, указывающей место изменения коммита. Например, события, kafka, userModel, авторизация, аутентификация, loginPage и т.д.

<description>

Это очень краткое описание изменения.

• Используйте повелительное наклонение, настоящее время: «изменить», а не «изменено» или «изменения».
• Не используйте заглавные буквы в начале.
• Без точки (.) в конце.

Тело сообщения

— так же, как и в теме, используйте повелительное наклонение, настоящее время: «изменение», а не «изменённое» или «изменение». — включает мотивацию для изменения и контрастирует с предыдущим поведением.

http://365git.tumblr.com/post/3308646748/writing-git-commit-messages

http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Нижний колонтитул сообщения

Законченные, исправленные или доставленные истории должны быть перечислены в отдельной строке нижнего колонтитула с префиксом «Завершает», «Исправляет» или «Доставляет» ключевое слово, например:

[(Завершает|Исправляет|Доставляет) #ISSUE_ID]

Пример сообщения

feat(kafka): реализовать ровно один раз доставку

- гарантировать, что каждое событие, опубликованное в kafka, доставляется ровно один раз
- реализовать обработку ошибок при неудачной доставке

Доставляет #065

fix(логин): разрешить предоставленным пользовательским настройкам переопределять настройки приложения по умолчанию

- Это позволяет настройкам, связанным с учётной записью пользователя, переопределить и настроить настройки приложения по умолчанию, такие как тема, часовой пояс и т. д.

Исправляет #025

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

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

Ресурсы

• Как вносить вклад в проекты с открытым исходным кодом
• Использование запросов на включение изменений