Руководство для участников
Мы искренне приветствуем вклад в наш проект. Наша миссия — создать счастливое сообщество, где все помогают друг другу!
Есть много способов внести свой вклад в сообщество ThingLinks:
💻 Код: Помочь сообществу выполнить некоторые задачи, написать новые функции или исправить некоторые ошибки;
⚠️ Тестирование: Принять участие в написании тестового кода, включая модульное тестирование, интеграционное тестирование, сквозное тестирование (e2e);
📖 Документация: Написать или улучшить документацию, чтобы помочь пользователям лучше понять и использовать ThingLinks;
📝 Блог: Вы можете писать статьи о ThingLinks, чтобы помочь сообществу лучше продвигать продукт;
🤔 Обсуждение: Вы можете участвовать в обсуждении новых функций ThingLinks и интегрировать свои идеи с ThingLinks;
💡 Проповедь: Можете помочь популяризировать или продвигать сообщество ThingLinks, выступать на встречах или саммитах;
💬 Предложение: Вы также можете внести некоторые предложения в проект или сообщество, чтобы способствовать здоровому развитию сообщества;
Подробнее см. Типы вклада.
Даже небольшие исправления опечаток очень приветствуются :)
Запустите код ThingLinks в своих инструментах разработки и сможете отлаживать его. Это проект с разделением на фронтенд и бэкенд. Вам нужно запустить бэкенд «thinglinks» и фронтенд «thinglinks-ui» отдельно, чтобы они работали эффективно.
Найдите интересующую вас задачу! В нашем списке проблем GitHub мы часто публикуем некоторые проблемы с меткой «хорошая первая проблема» или статусом: «требуется доброволец». Эти проблемы приветствуют помощь участников. Среди них хорошие первые проблемы, как правило, имеют низкие пороги и подходят для новичков.
Конечно, если у вас есть хорошая идея, вы также можете предложить её напрямую в разделе обсуждения GitHub или связаться с сообществом.
git clone https://github.com:${YOUR_USERNAME}/thinglinks.git #Recommended
git checkout -b a-feature-branch #Recommended
git add <изменённый файл/путь>
git commit -m '[docs]feature: необходимые инструкции' #Recommended
git push origin a-feature-branch
Обратите внимание, что заголовок PR должен соответствовать нашей спецификации, и напишите необходимое описание в PR, чтобы облегчить проверку кода коммиттерами и другими участниками.
После отправки PR комитет или друзья сообщества рассмотрят отправленный вами код (Code Review) и предложат некоторые изменения или проведут обсуждение. Пожалуйста, своевременно обратите внимание на свой PR.
Если потребуются последующие изменения, нет необходимости инициировать новый PR. После отправки коммита в исходную ветку и отправки его в удалённый репозиторий PR будет автоматически обновлён.
Кроме того, в нашем проекте относительно стандартизированный и строгий процесс проверки CI. После отправки PR будет запущен CI. Обратите внимание, проходит ли он проверку CI.
Наконец, коммиттеры могут объединить PR в основную ветку.
После объединения кода вы можете... Как стать коммиттером?
После выполнения описанных шагов вы становитесь участником проекта ThingLinks. Чтобы оставаться активным участником сообщества и в перспективе стать коммиттером, повторяйте эти шаги.
Руководство для участников
Мы приветствуем участие в проекте и стремимся поддерживать сообщество, где все помогают друг другу.
Даже небольшие исправления орфографии приветствуются!
Запуск ThingLinks
Запустите код ThingLinks на вашем инструменте разработки и обеспечьте возможность отладки с точками останова. Это проект с разделением на передний и задний план, для локального запуска кода необходимо отдельно запустить бэкенд «thinglinks» и фронтенд «thinglinks-ui».
Поиск задач
Ищите интересные задачи! В нашем репозитории GitHub и списке рассылки мы часто публикуем задачи с тегами «good first issue» или «status: volunteer wanted», которые ждут помощи участников. Задачи «good first issue», как правило, имеют низкий порог входа и подходят для новичков.
Конечно, если у вас есть хорошие идеи, вы также можете предложить их напрямую в разделе обсуждений GitHub.
Отправка Pull Request
git clone https://github.com:${YOUR_USERNAME}/thinglinks.git #Recommended
git checkout -b a-feature-branch #Recommended
git add <изменённый файл/путь>
git commit -m '[docs]feature: необходимые инструкции' #Recommended
git push origin a-feature-branch
Обратите внимание, что заголовок PR должен соответствовать нашим стандартам, а в описании PR должны быть предоставлены необходимые пояснения для облегчения проверки кода коммиттерами и другими участниками.
Ожидание слияния PR
После отправки PR коммиттеры или участники сообщества проведут проверку вашего кода (Code Review), предложат изменения или проведут обсуждение. Будьте внимательны к своему PR.
Если потребуются дальнейшие изменения, не нужно создавать новый PR — просто внесите изменения в существующую ветку, отправьте их на удалённый репозиторий, и PR автоматически обновится.
Кроме того, наш проект имеет строгие процессы CI (Continuous Integration), и после отправки PR будет запущен CI. Убедитесь, что проверка прошла успешно.
Наконец, коммиттер может объединить PR с основной веткой DEV.
После слияния кода
Когда код будет объединён, вы сможете удалить эту ветку разработки как на локальном, так и на удалённом репозиториях:
git branch -d a-dev-branch
git push origin --delete a-dev-branch
На основной ветке вы можете выполнить следующие действия для синхронизации с вышестоящим репозиторием:
git remote add upstream https://github.com/mqttsnet/thinglinks.git #Bind the remote warehouse, if it has been executed, it does not need to be executed again
git checkout main
git pull upstream main
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )