Инструкция по открытому вкладу в XuperChain

[ English | 中文 ]

Сначала, большое спасибо за ваше желание сделать открытый вклад в проект XuperChain.

Перед тем как отправить свой вклад, пожалуйста, ознакомьтесь с данной инструкцией по открытому вкладу и следуйте правилам создания issue и pull requests. Чтобы обеспечить бесперебойное взаимодействие на GitHub, мы настоятельно рекомендуем использовать английский язык при создании issue или pull requests.

Создание issue

Проект XuperChain использует систему issue GitHub для управления багами и предложениями новых функций. Перед тем как создать новый issue, пожалуйста, выполните поиск среди существующих issue, чтобы проверить наличие аналогичной проблемы. Если вы нашли похожий issue, просто добавьте свои данные в этот issue через комментарий. Если вы уверены, что такой issue еще не существует, то смело создайте новый issue.

При создании issue, пожалуйста, используйте уже предоставленные шаблоны issue, заполнив следующую информацию:

• Короткое описание основной проблемы.
• Ваша система. Включает версию XuperChain, OS/Go/Gcc и т.д.
• Опишите, что вы ожидали увидеть.
• Опишите, что вы действительно заметили.
• Предоставьте логи, скриншоты и любые полезные указания. Если возможно, предоставьте минимально воспроизводимый пример кода для помощи в подтверждении проблемы.Обратите внимание: Система issue предназначена только для отчета о багах и предложений новых функций. Если вы хотите получить консультацию по техническим деталям или другим вопросам, пожалуйста, просмотрите наш wiki. Если ответы на ваши вопросы не найдены в wiki, присоединитесь к официальному WeChat-чату по технологиям XuperChain через QR-код на главной странице сайта. Любой issue, который не соответствует вышеописанным требованиям, может быть закрыт без предварительного уведомления.

Отправка кода

Проект XuperChain принимает кодовые вклады через стандартный процесс pull request на GitHub. Сначала fork репозиторий, добавьте исправленный код в свой fork и отправьте pull request на XuperChain. Поддерживаемые разработчики будут проводить Code Review вашего кода после получения pull request и, если все в порядке, они объединят его с основным репозиторием.

Пожалуйста, используйте следующий шаблон для отправки pull request:

• Какова цель ваших изменений в коде?
• Коротко опишите ваш подход к решению этой проблемы.Каждый pull request должен быть связан с конкретным issue, и номер этого issue следует указывать в описании pull request. Ваш pull request должен пройти CI-тестирование для снижения рисков возникновения новых проблем, а затем он будет проверяться минимум двумя поддерживаемыми разработчиками. Это может занять некоторое время, поэтому будьте терпеливы. Обратите внимание: Ваш код должен соответствовать официальным правилам оформления кода на языке Go (можно проверять с помощью gofmt и golint).## Подписание соглашения о лицензии для участников проекта (Contributor License Agreement, CLA)

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

Вы можете просмотреть и подписать соглашение о лицензии для участников проекта XuperChain по этой ссылке. Также вы можете подписать CLA через автоматически отправленную ссылку при создании pull request.

Активные участники могут получить приглашение присоединиться к команде основных вкладчиков XuperChain и получить права на слияние pull requests.