Добро пожаловать! Мы будем рады любым вкладам. Пожалуйста, ознакомьтесь с нашим руководством по внесению вклада перед тем, как создавать Pull Request для jcli.

Golang Environment

Настройка модуля Go proxy может ускорить загрузку зависимостей:

export GOPROXY=https://mirrors.aliyun.com/goproxy/

CLI

jcli — это интерфейс командной строки (CLI). Поэтому фреймворк CLI очень важен для нас. Благодаря cobra он помогает нам делать работу лучше.

Jenkins REST API

API — ещё одна важная часть этого проекта. jcli управляет Jenkins через REST API. На данный момент полной спецификации для этого API нет, Jenkins core и плагины предоставляют документацию независимо друг от друга. Вы можете разобраться самостоятельно или просто присоединиться к нашему чату на gitter, чтобы задать вопросы о конкретных API, если это необходимо.

Полезные ссылки:

• Jenkins Remote Access API;
• обзор Jenkins REST API от Cliffano Subagio.

Плагины

Jenkins CLI позволяет вам написать плагин для него. Вы можете выполнить следующие шаги:

1. Написать проект плагина, например jcli-account-plugin.
2. Отправить файл метаданных в официальный репозиторий.

Тестирование

Мы используем BDD Testing Framework для тестирования нашего проекта. Перед тем как вносить свой вклад, убедитесь, что вы знакомы с ginkgo.

Тестирование вручную

Модульное тестирование может нам очень помочь, но ручное тестирование всё ещё необходимо. Я настоятельно рекомендую вам протестировать его в совершенно новой среде. Вот список бесплатных ресурсов, которые вы можете использовать:

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

Pull Requests

Прежде чем начать, пожалуйста, разветвите этот проект на своём аккаунте GitHub. Затем создайте ветку git на основе того, что вы хотите улучшить. Пожалуйста, никогда не используйте основную ветку в качестве ветки разработки. И поведение git force push не рекомендуется при отправке запросов на вытягивание.

Пожалуйста, не создавайте ещё один запрос на вытягивание, если вы испортили свои записи git commit.

Чтобы создать хорошие заметки о выпуске, пожалуйста, подумайте о том, чтобы написать правильное название запроса на вытягивание. release-draft сгенерирует заметки на основе вашего заголовка.

Качество

Качество — сердце проекта. Поэтому, пожалуйста, убедитесь, что ваш запрос на вытягивание проходит через Sonar Quality Gate.

Хорошее начало

Проблемы новичка — хорошее начало.

Git Backup

Мы используем git-backup-actions для резервного копирования этого репозитория в gitee.

Среда разработки

Если вы хотите участвовать в этом проекте, вам необходимо выполнить следующую команду: make tools.

Релиз

Snapcraft