1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/xuexb-github-bot

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 7.1 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 27.11.2024 20:25 92ea373

Руководство по вкладу от пользователей

Благодарим вас за интерес к проекту @xuexb/github-bot. Прежде чем отправлять свой вклад, пожалуйста, внимательно прочитайте следующие инструкции.

  1. Обратная связь
  2. Руководство по разработке
    1. Локальная отладка
    2. Часто используемые команды скриптов (npm scripts)
    3. Стиль кода
    4. Структура проекта
    5. Запрос на слияние (pull request)
  3. Стандарты оформления сообщений о фиксации изменений
  4. Заключение

Обратная связь

  1. Избегайте отправки повторяющихся проблем, перед отправкой выполните поиск существующих проблем.
  2. Используйте страницу Создать проблему для обратной связи, иначе она будет немедленно закрыта.

Настройка разработки

Требуется установить версию Node.js 7.8.0 или выше. После загрузки проекта на локальный компьютер установите зависимости с помощью команды npm install. После установки автоматически добавится проверка формата сообщения о фиксации и проверка формата кода перед фиксацией.

Локальная отладка

В настоящее время отладка основана на интерфейсе API GitHub + https://github.com/octokit/node-github + онлайн-перехватчики GitHub, которые запускаются в реальном времени. Планируется добавить фиктивный сервис для поддержки локальной отладки кода в реальном времени.

Часто используемые команды скриптов (npm scripts)

# Запуск локального сервера интерфейса на основе koa
$ npm run start

# Проверка стиля кода с использованием eslint
$ npm run lint

Стиль кода

Разработка на основе ES6, использование стандарта кодирования https://standardjs.com/, проверка стиля кода с помощью eslint.

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

.
├── create-issue.html                   - Страница создания проблемы, которая будет вставлять некоторые специальные метки в содержимое, чтобы бот мог определить, соответствует ли оно стандартам.
└── src
    ├── app.js                          - Точка входа для запуска службы
    ├── github.js                       - Завершение интерфейса с использованием https://github.com/octokit/node-github + async
    └── modules                         - Разделение на модули на основе функций
        ├── issues                      - Проблемы
        │   ├── autoAssign.js           - Автоматическое назначение соответствующим лицам в соответствии с конфигурацией
        │   ├── autoLabel.js            - Автоматическая маркировка проблем в соответствии со специальными метками, вставленными на страницу create-issue.html
        │   ├── replyInvalid.js         - Определение наличия специальных меток, вставленных на страницу create-issue.html, и автоматическое закрытие в противном случае
        │   └── replyNeedDemo.js        - Ответ с указанием необходимости соответствующих демонстрационных ссылок
        ├── pull_request                - PR
        │   ├── autoReviewRequest.js    - Автоматическое назначение рецензента соответствующим лицам в соответствии с конфигурацией
        │   ├── replyInvalidTitle.js    - Автоматический запрос на изменение заголовка в соответствии со стандартами
        │   └── titlePrefixToLabel.js   - Автоматическая маркировка в соответствии со стандартом префикса заголовка и конфигурацией
        └── releases                    - Releases
            └── autoReleaseNote.js      - Добавление новых тегов автоматически классифицирует их на основе commit log, ближайшего к предыдущему тегу, и автоматически генерирует notes релизов
        └── utils.js                        - Общие методы инструментов

Запрос на слияние (pull request)

  1. Создайте форк @xuexb/github-bot
  2. Клонируйте личный репозиторий на компьютер и установите необходимые плагины.
  3. Начните редактирование и пройдите самопроверку, затем отправьте код заранее.
  4. Отправьте изменения в ветку.
  5. Создайте новый запрос на слияние и опишите изменения.

Стандарты оформления сообщений о фиксации

Сообщения git commit и заголовки запросов на слияние должны соответствовать правилам оформления commit-log и заголовков PR, иначе они не будут приняты.

Заключение

Спасибо за ваш вклад, благодаря вам github-bot становится лучше.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/xuexb-github-bot.git
git@api.gitlife.ru:oschina-mirror/xuexb-github-bot.git
oschina-mirror
xuexb-github-bot
xuexb-github-bot
master