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

Введение

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Владельцы

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

Версии

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

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

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

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

// Copyright 2016 The go-ego Project Developers. 
//
// Licensed under the Apache License, Version 2.0 (the "License"): you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, Файлы в репозитории содержат авторские права с года их добавления до года последнего изменения. Если автор авторских прав меняется, просто вставьте заголовок ниже старого.