diff options
author | VDV186 <82193531+VDV186@users.noreply.github.com> | 2021-05-23 20:32:38 +0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-05-23 23:32:38 +0700 |
commit | 06f7b092fc01d4007519ba1617ce66148a3986cf (patch) | |
tree | 3eaa9885567dd5cc63bd6bb95b8515ec716e2989 /files | |
parent | 325cdb72f8f6975c0746a33332f76510ada880d4 (diff) | |
download | translated-content-06f7b092fc01d4007519ba1617ce66148a3986cf.tar.gz translated-content-06f7b092fc01d4007519ba1617ce66148a3986cf.tar.bz2 translated-content-06f7b092fc01d4007519ba1617ce66148a3986cf.zip |
Translate open source etiquette (#952)
* Translate open source etiquette
* Apply suggestions from code review
Co-authored-by: Alexander Myshov <myshov@users.noreply.github.com>
* Update index.html
* Update files/ru/mdn/contribute/open_source_etiquette/index.html
* Update files/ru/mdn/contribute/open_source_etiquette/index.html
* Update files/ru/mdn/contribute/open_source_etiquette/index.html
* Update files/ru/mdn/contribute/open_source_etiquette/index.html
* Update files/ru/mdn/contribute/open_source_etiquette/index.html
* Update files/ru/mdn/contribute/open_source_etiquette/index.html
Co-authored-by: Alexander Myshov <myshov@users.noreply.github.com>
Diffstat (limited to 'files')
-rw-r--r-- | files/ru/mdn/contribute/open_source_etiquette/index.html | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/files/ru/mdn/contribute/open_source_etiquette/index.html b/files/ru/mdn/contribute/open_source_etiquette/index.html new file mode 100644 index 0000000000..fe785e67f6 --- /dev/null +++ b/files/ru/mdn/contribute/open_source_etiquette/index.html @@ -0,0 +1,165 @@ +--- +title: Основы этикета для проектов с открытым исходным кодом +slug: MDN/Contribute/Open_source_etiquette +tags: + - Best practices + - Сообщество + - Open source + - MDN + - Новичок + +--- +<p>{{MDNSidebar}}</p> + +<p>Если вы раньше не работали над проектом с открытым исходным кодом (OSP), хорошая идея прочитать эту статью, прежде чем начинать вносить свой вклад в MDN (или другие проекты с открытым исходным кодом). Есть несколько хороших способов, которые помогут вам и другим участникам проекта чувствовать себя ценными и в безопасности, а также оставаться продуктивными.</p> + +<p>Эта статья не научит вас всему, что касается участия в проекте с открытым исходным кодом; цель здесь состоит в том, чтобы дать вам несколько хороших отправных точек для размышлений и получения дополнительных сведений по мере того, как вы приступите к работе с открытым исходным кодом.</p> + +<h2 id="think_about_why_you_are_contributing_to_an_osp">Подумайте, почему вы вносите свой вклад в проект</h2> + +<p>Прежде чем начать вносить свой вклад в проект с открытым исходным кодом, спросите себя, почему вы хотите это сделать. Это нормально, если ответ на этот вопрос будет просто: «Мне скучно, и я хочу найти занятие, которое позволит мне сделать что-нибудь полезное в свободное время», но у вас может быть другая мотивация.</p> + +<p>Более подходящие причины могут быть такими:<p> + +<ul> + <li>Я пользуюсь этим продуктом всё время и обнаружил в нём ошибку или хочу помочь улучшить его.</li> + <li>Я хочу помочь в улучшении опыта использования этого продукта.</li> + <li>Я хочу помочь в улучшении опыта внесения вклада в этот проект.</li> + <li>Я хочу улучшить свои навыки.</li> + <li>Я хочу публично продемонстрировать свои навыки, которые приобрёл в рамках курса обучения в колледже или университете.</li> + <li>Я хочу публично продемонстрировать свои навыки, чтобы повысить свои шансы на получение работы.</li> +</ul> + +<p>Некоторые из этих причин корыстны, но это тоже нормально. Если вы тратите своё время на работу над проектом бесплатно, то разумно ожидать, что вы получите что-то от этого взамен, и на самом деле у вас гораздо больше шансов задержаться в проекте дольше и более продуктивно вносить свой вклад. Кроме того, ясное понимание своей мотивации поможет легче решить, с каких задач начать.</p> + +<p>Вот некоторые не очень хорошие причины, чтобы начать вносить свой вклад:</p> + +<ul> + <li>Я хочу с кем-нибудь поболтать.</li> + <li>Я хочу кого-нибудь потроллить или покомандовать.</li> + <li>Я хочу показать, какой я потрясающий.</li> +</ul> + +<p>Ваше присутствие в проекте должно быть продуктивным и не мешать другим продуктивно работать.</p> + +<h2 id="be_polite_be_kind_avoid_incendiary_or_offensive_language">Будьте вежливы, будьте добры, избегайте провоцирующих или оскорбительных выражений</h2> + +<p>Мы могли бы сократить это до «будь добр». Это наш совет номер один для всех, кто начинает участвовать в проекте с открытым исходным кодом.</p> + +<p>Будьте добры к другим участникам проекта, чтобы сделать его более приятным и продуктивным местом. Следуйте нижеприведенным правилам:</p> + +<ul> + <li>Благодарите людей, если они вам помогают.</li> + <li>Поздравляйте людей, где это уместно (например, если они отправили свой первый пулреквест или исправили сложную ошибку).</li> + <li>Всегда уважительно отвечайте людям, даже если вам кажется, что ответ на их вопрос очевиден или они повторяются.</li> + <li>Пытайтесь помочь людям стать лучше, в поддерживающей манере, например во время проверки пулреквеста или когда вы отвечаете на их вопросы. Сказать «это неправильно» или «вот ответ» далеко не так полезно, как сказать: «Это нормально, но я чувствую, что было бы лучше, если бы вы попытались сделать это вот так, вот сообщение в блоге, где вы найдете больше идей» или «вы можете найти ответ здесь; также перейдите по этой ссылке, чтобы получить больше информации».</li> +</ul> + +<p>Вы и другие участники находятся (или должны быть) здесь, потому что хотите внести положительный вклад в проект, но помимо этого, вы можете многого не знать о них. Например, их:</p> + +<ul> + <li>Знание проекта и технологий, использованных при его создании.</li> + <li>Пол, сексуальная ориентация, возраст, языки, местоположение, политические взгляды, религия или другие личные качества.</li> + <li>Опыт работы с проектами с открытым исходным кодом</li> + <li>Уверенность</li> + <li>Ожидания</li> + <li>Чувство юмора</li> +</ul> + +<p>Поэтому вам следует как можно чаще писать по теме, держаться подальше от потенциально спорных вопросов, не относящихся к теме, таких как религия или политика, и быть благосклонным и уважительным, даже если вы не согласны с кем-то или вам не нравится решение, которое кто-то принял.</p> + +<p>Кроме того, вам следует воздерживаться от любых ругательств или ненормативной лексики на MDN, даже если они не адресованы кому-либо конкретно. Грубый язык мешает здоровому развитию проекта, кроме того некоторые люди могут быть очень чувствительны к этому.</p> + +<p>Имейте в виду, что в любом хорошем проекте с открытым исходным кодом существуют правила, защищающие его участников от дискомфорта, когда они вносят свой вклад. Обычно эти правила находятся в файле CODE_OF_CONDUCT.md на GitHub.</p> + +<p>Например, репозитории MDN регулируются широко распространенными <a href="https://www.mozilla.org/en-US/about/governance/policies/participation/">Рекомендациями по участию в сообществе Mozilla</a>. Обычно при умеренно неподобающем поведении в репозиториях MDN (например, постоянное несоблюдение темы, нарушение работы или грубость) высылается предупреждение, за которым следует последнее предупреждение, а затем временный или постоянный бан. Более серьёзные поведенческие проблемы, такие как оскорбления или угрозы в адрес другого участника, недопустимы и, скорее всего, приведут к мгновенному бану.</p> + +<p>Если вы сталкиваетесь с чем-то, что заставляет вас чувствовать себя некомфортно, вы всегда должны сообщать об этом, используя механизм, предусмотренный в кодексе поведения.</p> + +<h2 id="choose_impactful_contributions">Выбирайте полезные вклады в проект</h2> + +<p>Подумайте, чем вы хотите заниматься в проекте. Например, у нас есть большой список проблем, расположенный на <a href="https://github.com/mdn/content/issues">https://github.com/mdn/content/issues</a>, разбитый по различным категориям GitHub таких, как предполагаемое время на исправления, вид технологий и многое другое. Ещё одна хорошая категория, на которую стоит обратить внимание, — «good first issue». Она обычно присваивается задачам, которые довольно просты и удобны для начинающих, с которых можно начать работу над проектом. Мы также вскоре собираемся начать более тщательную сортировку наших проблем, добавляя другие категории, такие как индикаторы приоритета. Попробуйте выбрать несколько проблем, с которыми, по вашему мнению, вы сможете справиться, используя имеющееся у вас время, и попросите, чтобы вас назначили на них</p> + +<p>Вы также можете внести свой вклад, открывая пулреквесты, чтобы исправить проблемы, с которыми вы сталкиваетесь при чтении статей MDN.</p> + +<p>Большая часть работы над MDN вращается вокруг написания документации и примеров кода, но есть и другие способы внести свой вклад:</p> + +<ul> + <li>Помочь в сортировке возникающих проблем.</li> + <li>Помочь с исправлением опечаток.</li> + <li>Помочь улучшить грамматику и сделать страницы более понятными.</li> + <li>Помочь в обучении людей, которые пытаются внести свой вклад.</li> +</ul> + +<p>Каждое исправление полезно независимо от его размера, и мы не откажемся от него. Однако при этом постарайтесь убедиться, что ваши исправления продуктивны. Мы не советуем делать такие вклады как:</p> + +<ul> + <li>Обновление стиля кода только потому, что «вам больше нравится этот стиль».</li> + <li>Обновление стиля изложения «просто потому, что он вам больше нравится».</li> + <li>Замена страниц с американского английского на британский английский.</li> + <li>Добавление или удаление множества знаков препинания, когда на самом деле все в порядке.</li> + <li>Изменение фреймворка тестирования, который мы используем, на что-то другое, потому, что вам так больше нравится.</li> +</ul> + +<p>В большинстве случаев есть веская причина существования многих вещей на проекте с открытым исходным кодом. Вам следует прочитать руководства к ним, если они есть. Если вы сомневаетесь в правильности чего-либо, всегда спрашивайте об этом!</p> + +<h2 id="read_the_manual">Читайте руководство</h2> + +<p>Хорошие проекты всегда делают документацию доступной для участников. В проектах GitHub она обычно находится в файле CONTRIBUTING.md репозитория или иногда в файле README.md проекта. Будучи проектом документации, в контентной части MDN есть <a href="https://github.com/mdn/content/blob/main/README.md">README</a> и приличный набор документов для участников на самом сайте (см. <a href="/en-US/docs/MDN/Contribute">Участие в развитии MDN</a>).</p> + +<p>Хорошее правило: не бойтесь просить о помощи, но ВСЕГДА постарайтесь найти ответ на свой вопрос, прежде чем спрашивать. Таким образом вы улучшите свои знания о проекте и станете более независимыми и не возложите ненужное бремя на других участников.</p> + +<p>Конечно, документы не всегда будут идеальными. Если вы обнаружите что-то, что трудно найти или не очень хорошо объяснено, сообщите о проблеме или создайте пулреквест с исправлением.</p> + +<h2 id="find_out_where_to_ask_questions">Выясняйте, где задавать вопросы</h2> + +<p>Всегда выясняйте, где лучше всего задавать вопросы. Хорошие проекты всегда будут чётко указывать на это в своей документации (см. <a href="/en-US/docs/MDN/Contribute/Getting_started#step_4_ask_for_help">Раздел «Обратитесь за помощью»). </a>). Если вы хотите задать общие вопросы, всегда используйте эти каналы. Не создавайте ишью на GitHub для каждого простого вопроса, так как это добавляет шума в проект (см. «Делай прогресс, а не шум» ниже).</p> + +<h2 id="make_progress_not_noise">Делай прогресс, а не шум</h2> + +<p>Тщательно подумайте о том, как вы общаетесь в проекте — убедитесь, что это приносит пользу и не усложняет работу другим участникам. Отправлять запросы на исправление ошибок — это здорово, но действительно ли они полезны и легко ли их проверить? Заводить ишью и присоединяться к другим обсуждениям — это нормально, но относятся ли ваши вопросы и комментарии к теме или они просто добавляют шума?</p> + +<p>Правильно делать так:</p> + +<ul> + <li>Обсуждайте одну тему в каждом ишью – это позволяет легко сосредоточить внимание на вопросе и работать продуктивно.</li> + <li>Исправляйте одно ишью одним пулреквестом — это может показаться немного сложным для вас, но проверить одно понятное исправление гораздо проще, чем несколько. </li> + <li>Участвуйте в других обсуждениях, если у вас есть полезное замечание или вы можете ответить на чей-нибудь вопрос.</li> + <li>Если у вас возник простой вопрос или если вы не уверены в его пользе, используйте другие каналы связи, такие как чаты или форумы.</li> + <li>Прежде чем задать вопрос, сначала прочтитайте руководство и попытайтесь найти ответ самостоятельно.</li> +</ul> + +<p>Не стоит:</p> + +<ul> + <li>Усложнять открытые ишью, пытаясь обсудить сразу несколько тем или делая комментарии не по теме.</li> + <li>Стараться втиснуть несколько исправлений в один пулреквест. Это значительно усложняет проверку и вызывает подозрения (некоторые люди могут подумать, что вы пытаетесь скрытно добавить вредоносный код).</li> + <li>Открывать много ишью, задавая расплывчатые вопросы.</li> + <li>Задавать вопросы, не пытаясь сначала решить проблему самостоятельно.</li> +</ul> + +<h2 id="osps_are_a_democracy_almost">OSP — это демократия (почти)</h2> + +<p>OSP (проекты с открытым исходным кодом) довольно демократичны — многие решения принимаются на голосовании, и вы в значительной степени свободны вносить свой вклад, как хотите, при условии, что вы не препятствуете другим вносить свой вклад.</p> + +<p>Однако некоторые вещи будут в значительной степени решаться небольшой группой основных участников. Вы можете обжаловать любое решение, но иногда модератор принимает решение, которое противоречит вашему мнению. Вы должны уважать и принимать эти решения.</p> + +<p>Полезно знать модераторов любого проекта, чтобы вы знали, к кому лучше обратиться за помощью, например, в пулреквестах или в обсуждениях проблем.</p> + +<h2 id="be_patient_be_timely">Будьте терпеливы и своевременны</h2> + +<p>Имейте в виду, что многие люди, работающие над проектом, делают это в свободное время без оплаты, и все люди, работающие над проектом, обычно очень заняты. Если вы ждёте чего-то, например, рассмотрение пулреквеста или ответа на вопрос, наберитесь терпения.</p> + +<p>Разумно подождать несколько дней, а затем связаться с человеком, чтобы спросить, было ли у него время посмотреть на ваш вопрос, и, возможно, через неделю снова связаться с ним, чтобы спросить, не слишком ли он сейчас занят.</p> + +<p>Неразумно начинать требовать что-то в такой манере, как будто вы имеете право на быстрый ответ.</p> + +<p>Если кто-то ждёт, что вы что-то сделаете для них, вы можете рассчитывать на соответствующую вежливость с их стороны, но в то же время постарайтесь ответить как можно быстрее. Если вы, действительно, не можете найти время, дайте им знать и попросите мейнтейнеров проекта помочь найти для вас замену.</p> + +<h2 id="see_also">Смотрите также</h2> + +<ul> + <li><a href="https://opensource.guide/how-to-contribute/">Как внести свой вклад в развитие проекта с открытым исходным кодом (статья написана на английском языке)</a></li> + <li><a href="https://github.com/freeCodeCamp/how-to-contribute-to-open-source">Общий список ресурсов от freeCodeCamp «Как внести свой вклад в развитие проекта с открытым исходным кодом»</a></li> + <li><a href="https://stackoverflow.blog/2020/08/03/getting-started-with-contributing-to-open-source/">Начало работы над проектом с открытым исходным кодом (статья написана на английском языке)</a></li> +</ul> |