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

OSCHINA-MIRROR/veni0-robotn

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 7.5 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 28.11.2024 12:06 2725cc3

Руководство по внесению изменений

Введение

В этом документе объясняется, как вносить изменения в проект Robotgo. Предполагается, что вы ознакомились с README.md и API Document.

Вопросы, связанные с безопасностью, следует сообщать по адресу security@Robotgo.io.

Отчёты об ошибках

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

Если ошибка уникальна, откройте новую проблему и ответьте на вопросы, чтобы мы могли понять и воспроизвести проблемное поведение.

Вы должны убедить нас, что это действительно ошибка в Robotgo. Это проще всего сделать, если вы напишете чёткие и краткие инструкции, чтобы мы смогли воспроизвести поведение (даже если оно кажется очевидным). Чем более подробными и конкретными вы будете, тем быстрее мы сможем вам помочь. Ознакомьтесь с Как эффективно сообщать об ошибках.

Пожалуйста, будьте добры, помните, что Robotgo предоставляется вам бесплатно, и вы получаете бесплатную помощь.

Обсудите свой дизайн

Проект приветствует предложения, но, пожалуйста, сообщите всем, над чем вы работаете, если хотите что-то изменить или добавить в репозитории Robotgo.

Прежде чем начать писать что-то новое для проекта Robotgo, пожалуйста, создайте новую проблему. Значительные изменения должны пройти через процесс предложения изменений, прежде чем они могут быть приняты.

Этот процесс даёт каждому возможность проверить дизайн, помогает предотвратить дублирование усилий и гарантирует, что идея соответствует целям проекта и инструментам. Он также проверяет, надёжен ли дизайн, прежде чем будет написан код; инструмент проверки кода — не место для высокоуровневых обсуждений.

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

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

Проверка кода

Изменения в Robotgo должны быть проверены перед их принятием, независимо от того, кто вносит изменения, даже если это сопровождающий. Мы используем рабочий процесс запросов на вытягивание GitHub для этого, а также используем LGTM, чтобы гарантировать, что каждый PR проверяется как минимум двумя сопровождающими.

Подпишите свою работу

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

Сопровождающие

Чтобы убедиться, что каждый запрос на включение проверен, у нас есть команда сопровождающих. Сопровождающий должен быть участником проекта Robotgo и внести как минимум 4 принятых запроса на включение.

Владельцы

Поскольку Robotgo является чисто общественной организацией без какой-либо поддержки компании, авторские права принадлежат разработчикам проекта go-vgo 2016 года.

Версии

У Robotgo есть ветка master в качестве ветки подсказки, и есть ветки версий, такие как v0.30.0. v0.40.0 — это ветка выпуска, и мы пометим v0.40.0 для бинарной загрузки. Если в v0.40.0 есть ошибки, мы примем запросы на включение в ветке v0.40.0 и опубликуем тег v0.40.1, после внесения исправления также в основную ветку.

Так как ветка master является вершиной версии, если вы хотите использовать Robotgo в производстве, пожалуйста, загрузите последнюю версию тега выпуска. Все ветки будут защищены через GitHub, все запросы на включение каждой ветки должны быть рассмотрены двумя сопровождающими и должны пройти автоматические тесты.

Авторские права

Код, который вы предоставляете, должен использовать стандартный заголовок авторских прав:

// Copyright 2016 The go-vgo Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// https://github.com/go-vgo/robotgo/blob/master/LICENSE
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or Файлы в репозитории содержат авторские права с года их добавления до года последнего изменения. Если автор авторских прав меняется, просто вставьте заголовок ниже старого.
1
https://api.gitlife.ru/oschina-mirror/veni0-robotn.git
git@api.gitlife.ru:oschina-mirror/veni0-robotn.git
oschina-mirror
veni0-robotn
veni0-robotn
master