Coding Starter Projects

Кодирование-звезды-проекты

Основной репозиторий, чтобы поделиться своими стартовыми проектами с другими, а также помочь им расти!

Во -первых, спасибо, что нашли время внести свой вклад!

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

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

• Светь проект
• Твитнуть об этом
• Отправьте этот проект в Readme вашего проекта
• Укажите проект на местных встречах и расскажите своим друзьям/коллегам

Оглавление

• Нормы поведения
• У меня есть вопрос
• Я хочу внести свой вклад
• Сообщать об ошибках
• Предполагая усовершенствования

Нормы поведения

Этот проект и все, кто участвует в нем, регулируется кодексом поведения. MD. Участвуя, вы должны поддержать этот кодекс. Пожалуйста, сообщите о неприемлемом поведении <>.

У меня есть вопрос

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

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

Если вы по -прежнему чувствуете необходимость задать вопрос и нуждаетесь в разъяснениях, мы рекомендуем следующее:

• Откройте проблему.
• Предоставьте как можно больше контекста о том, с чем вы сталкиваетесь.
• Предоставьте версии проекта и платформы (Nodejs, NPM и т. Д.), В зависимости от того, что кажется актуальным.

Затем мы позаботимся о проблеме как можно скорее.

Я хочу внести свой вклад

Юридическое уведомление

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

Сообщать об ошибках

Перед отправкой отчета об ошибке

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

• Убедитесь, что вы используете последнюю версию.
• Определите, действительно ли ваша ошибка является ошибкой, а не ошибкой на вашей стороне, например, используя несовместимые компоненты/версии среды (убедитесь, что вы прочитали документацию. Если вы ищете поддержку, вы можете проверить этот раздел).
• Чтобы увидеть, испытали ли другие пользователи (и потенциально уже решены) та же проблема, которая у вас возникла, проверьте, не существует ли нет отчета об ошибке для вашей ошибки или ошибки в трекере ошибок.
• Также обязательно выполните поиск в Интернете (включая переполнение стека), чтобы увидеть, обсуждали ли пользователи за пределами сообщества GitHub эту проблему.
• Соберите информацию о ошибке:
• Stack Trace (Traceback)
• ОС, платформа и версия (Windows, Linux, MacOS, X86, ARM)
• Версия интерпретатора, компилятора, SDK, среды выполнения, менеджер пакетов, в зависимости от того, что кажется актуальным.
• Возможно, ваш вход и выход
• Можете ли вы надежно воспроизвести проблему? И можете ли вы также воспроизвести его старыми версиями?

Как мне представить хороший отчет об ошибке?

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

Мы используем проблемы GitHub для отслеживания ошибок и ошибок. Если вы столкнетесь с проблемой с проектом:

• Откройте проблему. (Поскольку на данный момент мы не можем быть уверены, что это ошибка или нет, мы просим вас не говорить о ошибке и не маркировать проблему.)
• Объясните поведение, которое вы ожидаете, и фактическое поведение.
• Пожалуйста, предоставьте как можно больше контекста и опишите шаги воспроизведения , за которыми может следовать кто -то другой, чтобы воссоздать проблему самостоятельно. Это обычно включает ваш код. Для хороших отчетов об ошибках вы должны выделить проблему и создать сокращенный тестовый пример.
• Предоставьте информацию, которую вы собрали в предыдущем разделе.

Как только он будет подан:

• Команда проекта будет соответствующим образом назвать проблему.
• Член команды попытается воспроизвести проблему с помощью предоставленных шагов. Если нет никаких шагов воспроизведения или нет очевидного способа воспроизведения проблемы, команда попросит вас о этих шагах и пометит проблему как needs-repro . Ошибки с тегом needs-repro не будут рассматриваться до тех пор, пока они не будут воспроизведены.
• Если команда может воспроизводить проблему, она будет отмеченной needs-fix , а также, возможно, других тегов (например, critical ), и проблема будет оставлена ​​для реализации кем-то.

Предполагая усовершенствования

Этот раздел направляет вас путем представления предложения по улучшению для составления. MD, включая совершенно новые функции и незначительные улучшения существующей функциональности . Следуя этим руководящим принципам поможет сопровождающим и сообществу понять ваши предложения и найти связанные предложения.

Перед отправкой улучшения

• Убедитесь, что вы используете последнюю версию.
• Внимательно прочитайте документацию и узнайте, будет ли функциональность уже покрыта, возможно, индивидуальной конфигурацией.
• Выполните поиск, чтобы увидеть, не было ли предложено улучшение. Если это так, добавьте комментарий к существующей проблеме вместо того, чтобы открывать новый.
• Узнайте, соответствует ли ваша идея с масштабами и целями проекта. Вам решать, что вы можете убедить разработчиков проекта в достоинствах этой функции. Имейте в виду, что нам нужны функции, которые будут полезны для большинства наших пользователей, а не просто небольшое подмножество. Если вы просто нацелены на меньшинство пользователей, рассмотрите возможность написания библиотеки дополнений/плагина.

Как мне представить хорошее предложение об улучшении?

Предложения по улучшению отслеживаются как проблемы с GitHub.

• Используйте четкое и описательное название для проблемы, чтобы определить предложение.
• Предоставьте пошаговое описание предложенного улучшения в как можно больше деталей.
• Опишите текущее поведение и объясните, какое поведение вы ожидали увидеть вместо этого и почему. На этом этапе вы также можете сказать, какие альтернативы не работают для вас.
• Возможно, вы захотите включить скриншоты и анимированные GIF -файлы , которые помогут вам продемонстрировать шаги или указать на роль, с которой связано предложение. Вы можете использовать этот инструмент для записи GIF -файлов на MacOS и Windows, а также этот инструмент или этот инструмент на Linux.
• Объясните, почему это улучшение будет полезно для большинства пользователей. MD. Вы также можете захотеть указать на другие проекты, которые решили их лучше и которые могут послужить вдохновением.