Участие

Введение

Сначала спасибо за то, что рассмотрели возможность внесения вклада в проект Docsify! Люди как вы делают сообщество открытого программного обеспечения таким замечательным! 😊

Мы приветствуем любую форму участия, а не только код. Вы можете помочь с

• Контроль качества: отправьте отчеты о багах, чем больше деталей вы сможете предоставить, тем лучше (например, скриншоты с открытым консольным окном)
• Реклама: пишите блоги, руководства, печатайте наклейки, ...
• Общественность: представляйте проект на встречах, организуйте встречу для местного сообщества, ...
• Код: просмотрите открытые задачи. Даже если вы не умеете писать код, ваше участие в виде комментариев важно. Это помогает нам распределить задачи.
• Деньги: мы приветствуем финансовые вклады в полной прозрачности на нашем open collective.

Ваш первый вклад

Вы работаете над первым запросом на слияние? Вы можете узнать, как это сделать, из этого бесплатного курса, Как внести свой вклад в проект открытого программного обеспечения на GitHub.

Онлайн установка для участия одним щелчком мыши

Вы можете использовать Gitpod (бесплатная онлайн-IDE, аналогичная VS Code) для участия. Одним щелчком мыши запустится рабочее пространство и автоматически:- клонирует репозиторий docsify,

• устанавливает зависимости,
• запускает npm run dev.

npm install && npm run dev

Чтобы вы могли сразу начать работу.

• Создайте форк!
• Создайте ветку с новой функциональностью: git checkout -b my-new-feature
• Подтвердите изменения: git add . && git commit -m 'Добавление новой функциональности'
• Отправьте изменения в ветку: git push origin my-new-feature
• Предложите слияние через pull request

Внесение кода

Любой вносимый код должен быть представлен в виде запроса на слияние. Описание должно объяснять, что делает код, и давать шаги для его выполнения. В запросе на слияние также должны содержаться тесты.

Тестирование

Убедитесь, что все работает, выполнив:

npm test

Тестовые снимки экрана

Если снимок экрана провалился или вам нужно добавить новые снимки, выполните:

npx jest --update-snapshot

Процесс проверки кода

Чем больше запрос на слияние, тем дольше он будет проверяться и объединяться. Попробуйте разделить большие запросы на слияние на меньшие части, которые легче проверять и объединять. Постоянное наличие контекста для вашего запроса на слияние всегда полезно. Какова была цель? Почему это важно для вас?

Финансовые вкладыМы также приветствуем финансовые вклады с полной прозрачностью на нашем Open Collective.

Любой может представить расходы. Если расходы имеют смысл для развития сообщества, они будут "представлены" в бухгалтерской книге нашего Open Collective основными участниками, а человек, представивший расходы, будет возмещён.## Вопросы

Если у вас есть вопросы, создайте issues (совет: выполните быстрый поиск перед тем, как задать вопрос, чтобы убедиться, что никто до вас не задал такой же вопрос!). Вы также можете связаться с нами по адресу hello@docsify.opencollective.com.

Кредиты

Участники

Благодарим всех людей, кто уже внес свой вклад в проект Docsify!

Поддержка

Благодарим всех наших спонсоров! [Станьте спонсором]

СпонсорыБлагодарим всех наших спонсоров! (Пожалуйста, попросите вашу компанию также поддержать этот открытый проект, станьте спонсором)