Руководство по внесению открытого исходного кода в XuperChain

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

Перед этим, пожалуйста, прочитайте данное руководство по внесению открытого исходного кода и соблюдайте правила подачи проблем (issues) и запросов на включение (pull requests). Чтобы обеспечить беспрепятственное общение на GitHub, мы настоятельно рекомендуем вам использовать английский язык для подачи issues или pull requests.

Создание проблемы (issue)

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

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

• Краткое описание основной проблемы.
• Ваша системная среда, включая версию XuperChain, информацию о версии ОС/Go/GCC.
• Опишите, как вы считаете, должна происходить ситуация.
• Описать, что вы фактически наблюдаете.
• Предоставьте журналы, скриншоты и другие полезные подсказки. Если возможно, предоставьте минимальный проверяемый пример кода, который поможет нам подтвердить проблему.

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

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

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

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

• Какова цель изменений кода в PR?
• Кратко опишите ваше решение этой проблемы.

Все PR должны соответствовать существующей проблеме, и номер проблемы должен быть указан в описании PR. Ваш PR должен пройти проверку CI, чтобы снизить вероятность введения новых проблем, а затем пройти проверку как минимум двух разработчиков. Это может занять некоторое время, поэтому будьте терпеливы.

Примечание: Ваш код должен соответствовать официальному стилю кода Go (можно использовать gofmt и golint для проверки).

Подписание соглашения о лицензии для участников (Contributor License Agreement, CLA)

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

Вы можете просмотреть и подписать соглашение о лицензировании участников XuperChain по ссылке XuperChain Contributor License Agreement или подписать CLA через автоматическую ссылку при отправке PR.

Активные участники могут получить приглашение присоединиться к основной команде разработчиков XuperChain и получить право на слияние Pull Request.