Правила внесения вклада

Введение

Данный документ объясняет, как вносить изменения в проект Ego. Предполагается, что вы следовали указаниям в README.md и документации API.

Отчеты о багах

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

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

Бремя доказательства того, что это действительно баг в Ego, лежит на вас. Легче всего это сделать, если вы предоставите четкие и краткие инструкции, позволяющие нам воспроизвести поведение (даже если это кажется очевидным). Чем более подробно и конкретно вы будете описывать проблему, тем быстрее мы сможем вам помочь. Обратитесь к руководству по эффективному отслеживанию ошибок.

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

Дискуссия о дизайне

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

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

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

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

Рецензирование кода

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

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

Мантайнеры

Чтобы гарантировать проверку каждого запроса на внесение изменений (PR), мы имеем команду мантайнеров. Мантайнер должен быть участником проекта Ego и иметь минимум четыре принятых PR.

Владельцы

Поскольку Ego является чистым сообществом без какой-либо корпоративной поддержки, авторское право 2016—2017 годов принадлежит разработчикам проекта Go-Ego.

Версии

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

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

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

Код, который вы предоставляете, должен использовать стандартный шаблон авторского права:``` // Copyright 2016-2017 The go-ego Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // https://github.com/go-ego/ego/blob/master/LICENSE // // Лицензировано по лицензии Apache, Версия 2.0 <LICENSE-APACHE или // http://www.apache.org/licenses/LICENSE-2.0> или лицензии MIT // <LICENSE-MIT или http://opensource.org/licenses/MIT>, по вашему // выбору. Этот файл может не копироваться, модифицироваться или // распространяться, кроме случаев, предусмотренных этими условиями.

Файлы в репозитории содержат авторское право с года добавления до года последнего изменения. Если автор авторского права был изменён, просто вставьте заголовок ниже старого.