1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/mqttsnet-thinglinks

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 14 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 29.11.2024 01:35 e36917a

Руководство для участников

Мы искренне приветствуем вклад в наш проект. Наша миссия — создать счастливое сообщество, где все помогают друг другу!

Способы участия

Есть много способов внести свой вклад в сообщество ThingLinks:

  • 💻 Код: Помочь сообществу выполнить некоторые задачи, написать новые функции или исправить некоторые ошибки;

  • ⚠️ Тестирование: Принять участие в написании тестового кода, включая модульное тестирование, интеграционное тестирование, сквозное тестирование (e2e);

  • 📖 Документация: Написать или улучшить документацию, чтобы помочь пользователям лучше понять и использовать ThingLinks;

  • 📝 Блог: Вы можете писать статьи о ThingLinks, чтобы помочь сообществу лучше продвигать продукт;

  • 🤔 Обсуждение: Вы можете участвовать в обсуждении новых функций ThingLinks и интегрировать свои идеи с ThingLinks;

  • 💡 Проповедь: Можете помочь популяризировать или продвигать сообщество ThingLinks, выступать на встречах или саммитах;

  • 💬 Предложение: Вы также можете внести некоторые предложения в проект или сообщество, чтобы способствовать здоровому развитию сообщества;

Подробнее см. Типы вклада.

Даже небольшие исправления опечаток очень приветствуются :)

Запуск ThingLinks

Запустите код ThingLinks в своих инструментах разработки и сможете отлаживать его. Это проект с разделением на фронтенд и бэкенд. Вам нужно запустить бэкенд «thinglinks» и фронтенд «thinglinks-ui» отдельно, чтобы они работали эффективно.

Поиск задач

Найдите интересующую вас задачу! В нашем списке проблем GitHub мы часто публикуем некоторые проблемы с меткой «хорошая первая проблема» или статусом: «требуется доброволец». Эти проблемы приветствуют помощь участников. Среди них хорошие первые проблемы, как правило, имеют низкие пороги и подходят для новичков.

Конечно, если у вас есть хорошая идея, вы также можете предложить её напрямую в разделе обсуждения GitHub или связаться с сообществом.

Отправка запроса на вытягивание (Pull Request)

  1. Сначала вам нужно разветвить целевой репозиторий ThingLinks.
  2. Затем загрузите код локально с помощью команды git:
git clone https://github.com:${YOUR_USERNAME}/thinglinks.git #Recommended  
  1. После завершения загрузки обратитесь к руководству по началу работы или файлу README целевого репозитория, чтобы инициализировать проект.
  2. Затем вы можете обратиться к следующей команде, чтобы отправить код:
git checkout -b a-feature-branch #Recommended 
  1. Отправьте код как коммит, требуемый формат спецификации сообщения о коммите: [имя модуля или имя типа] функция или исправление ошибки или документ: пользовательское сообщение.
git add <изменённый файл/путь> 
git commit -m '[docs]feature: необходимые инструкции' #Recommended 
  1. Нажмите на удалённый репозиторий
git push origin a-feature-branch   
  1. Затем вы можете инициировать новый PR (запрос на вытягивание) на GitHub.

Обратите внимание, что заголовок PR должен соответствовать нашей спецификации, и напишите необходимое описание в PR, чтобы облегчить проверку кода коммиттерами и другими участниками.

Подождите, пока код будет объединён

После отправки PR комитет или друзья сообщества рассмотрят отправленный вами код (Code Review) и предложат некоторые изменения или проведут обсуждение. Пожалуйста, своевременно обратите внимание на свой PR.

Если потребуются последующие изменения, нет необходимости инициировать новый PR. После отправки коммита в исходную ветку и отправки его в удалённый репозиторий PR будет автоматически обновлён.

Кроме того, в нашем проекте относительно стандартизированный и строгий процесс проверки CI. После отправки PR будет запущен CI. Обратите внимание, проходит ли он проверку CI.

Наконец, коммиттеры могут объединить PR в основную ветку.

После объединения кода

После объединения кода вы можете... Как стать коммиттером?

После выполнения описанных шагов вы становитесь участником проекта ThingLinks. Чтобы оставаться активным участником сообщества и в перспективе стать коммиттером, повторяйте эти шаги.

Руководство для участников

Мы приветствуем участие в проекте и стремимся поддерживать сообщество, где все помогают друг другу.

  • Способы участия:
    • Код: помощь сообществу в выполнении задач, написание новых функций или исправление ошибок;
    • Тестирование: участие в написании тестов, включая модульное тестирование, интеграционное тестирование и сквозное тестирование;
    • Документация: написание или улучшение документации, чтобы помочь пользователям лучше понять и использовать ThingLinks;
    • Блог: написание статей о ThingLinks для продвижения сообщества;
    • Обсуждение: участие в обсуждении новых функций ThingLinks, интеграция ваших идей с ThingLinks;
    • Пропоганда: помощь в продвижении или распространении ThingLinks в Meetup или на саммитах;
    • Предложения: внесение предложений по проекту или сообществу для содействия его здоровому развитию;
    • и другие.

Даже небольшие исправления орфографии приветствуются!

Запуск ThingLinks

Запустите код ThingLinks на вашем инструменте разработки и обеспечьте возможность отладки с точками останова. Это проект с разделением на передний и задний план, для локального запуска кода необходимо отдельно запустить бэкенд «thinglinks» и фронтенд «thinglinks-ui».

  • Запуск бэкенда и фронтенда.
  • См. официальную документацию.

Поиск задач

Ищите интересные задачи! В нашем репозитории GitHub и списке рассылки мы часто публикуем задачи с тегами «good first issue» или «status: volunteer wanted», которые ждут помощи участников. Задачи «good first issue», как правило, имеют низкий порог входа и подходят для новичков.

Конечно, если у вас есть хорошие идеи, вы также можете предложить их напрямую в разделе обсуждений GitHub.

Отправка Pull Request

  1. Сначала вам нужно создать форк целевого репозитория ThingLinks (https://github.com/mqttsnet/thinglinks).
  2. Затем используйте команду git для загрузки кода на ваш компьютер:
git clone https://github.com:${YOUR_USERNAME}/thinglinks.git #Recommended  
  1. После загрузки рекомендуется ознакомиться с руководством по началу работы или файлом README целевого репозитория.
  2. Далее вы можете использовать следующие команды для разработки и отправки кода:
git checkout -b a-feature-branch #Recommended  
  1. Добавьте изменения в файлы, которые вы хотите зафиксировать, и выполните фиксацию с описанием, соответствующим соглашению: [имя модуля или тип] feature или bugfix или doc: пользовательское сообщение.
git add <изменённый файл/путь> 
git commit -m '[docs]feature: необходимые инструкции' #Recommended 
  1. Отправьте изменения на удалённый репозиторий:
git push origin a-feature-branch   
  1. Теперь вы можете создать новый PR (Pull Request) на GitHub.

Обратите внимание, что заголовок 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 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/mqttsnet-thinglinks.git
git@api.gitlife.ru:oschina-mirror/mqttsnet-thinglinks.git
oschina-mirror
mqttsnet-thinglinks
mqttsnet-thinglinks
main