Руководство по внесению вклада

Если вы заинтересовались внесением вклада в «Руководство по открытым исходникам», и у вас есть вопросы о том, как принять участие во внесении вклада, этот документ поможет вам сделать это более успешно.

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

Что нужно знать о внесении вклада

Формат

• Статьи должны быть написаны в формате Markdown.
• Статьи должны соответствовать стандартам написания.

Содержание

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

Способы внесения вклада

Прямая отправка PR

Если у вас есть предложения по изменению прочитанного контента и вы уже подготовили изменённый контент, вы можете внести свой вклад, отправив его через Fork + PR или Lightweight PR. Ваш PR будет рассмотрен группой авторов и экспертами по редактированию, а затем объединён с окончательным содержанием «Руководства по открытым исходникам».

Отправка Issue

Если вы хотите добавить определённый контент в «Руководство по открытым исходникам», но не знаете, с чего начать, вы можете отправить Issue, подробно описав желаемый контент. Те, кто заинтересован в этой теме, возьмут на себя ответственность за написание контента.

Принятие Issue

1. На странице Issue вы найдёте официальные и пользовательские запросы, связанные с «Руководством по открытым исходникам». Выберите тему, в которой вы разбираетесь, прокомментируйте и примите запрос. После подтверждения от группы авторов вы можете приступить к написанию.
2. Комментарий должен содержать имя автора + предполагаемое время завершения + примечание, например: «Gitee, планирую завершить часть контента 18 сентября». Когда пользователь с именем Gitee ответит «подтверждено», это означает, что вы можете начать работу над написанием.
3. Завершив написание, отправьте свой вклад через Fork + PR или Lightweight PR. Ваш PR пройдёт проверку группой авторов и экспертами по редактированию и будет включён в окончательное содержание «Руководства по открытым исходникам».