Начните свои занятия OSS с полным японским учебником
Это японский проект с открытым исходным кодом, предназначенный для того, чтобы для начинающих было легко участвовать.
Следуйте учебному пособию, чтобы испытать ваш первый вклад!
Мы рады помочь вам с вашим первым запросом на привлечение ✌
Введение
Этот проект является японским учебником, который поможет вам узнать, как использовать GIT/GitHub на практике и как сотрудничать в открытом исходном коде!
Для кого это?
- Новички, которые хотят изучать практические способы использования GIT/GitHub
- Люди, которые заинтересованы в открытом исходном коде, но не знают, как внести свой вклад
- Или вы хотите улучшить свои навыки, наслаждаясь сотрудничеством в рамках большего количества вкладов
Какова цель этого проекта?
- Испытайте реальную совместную разработку с использованием GitHub, чему трудно учиться самостоятельно.
- У всех есть уверенность и научиться вносить свой вклад в проекты с открытым исходным кодом
- И помогает разработчикам, которые любят культуру с открытым исходным кодом
Что такое открытый исходный код?
Что такое открытый исходный код?
Когда проект является открытым исходным кодом, это означает, что любой может использовать его по своему прихоти, учиться, модифицировать его и распространять свой проект для любых целей.
В большинстве случаев проекты с открытым исходным кодом могут свободно участвовать в разработке!
Вклад в проекты с открытым исходным кодом
Это отличный способ улучшить ваши навыки благодаря сотрудничеству с другими разработчиками.
Если вы не заинтересованы в открытом исходном коде и задаетесь вопросом, нужно ли вам приложить усилия.
Смотрите здесь: Зачем вносить свой вклад в открытый исходный код?
Как участвовать
Давайте сразу же испытаем вклад в проекты с открытым исходным кодом!
Что я должен делать?
Как участник этого проекта, мы добавим следующую информацию в наш файл Antormors.json!
"name": "あなたのハンドルネーム",
"github": "あなたのGitHubアカウントのURL",
"favoriteColor": "あなたの好きなカラーコード",
"favoriteEmoji": "あなたの好きな絵文字"
Введенная информация будет отображаться на веб -сайте как значок смайликов.
Таким образом, каждый раз, когда количество участников увеличивается, сайт становится живым!
эмодзи-анимация.mp4
Мы хотим сделать веб -сайт JA в первом вкладе еще более популярным, чем сейчас!
Пожалуйста, попробуйте переместить руки
- Фактическое перемещение ваших рук
- настраивать:
- Шаг 1: разветвляется этот репозиторий
- Шаг 2: клон на локальную машину
- Шаг 3: Создайте рабочую ветвь
- Шаг 4: Внесите изменения
- Шаг 5: совершите свои изменения
- Шаг 6: Нажмите изменения
- Шаг 7: Создайте запрос на вытяжение (PR)
- Шаг 8: Ответьте на отзывы и отзывы
- Заканчивать: ?
- Больше шагов
- Другие вклад
Фактическое перемещение ваших рук
Стать участником с открытым исходным кодом в 8 простых шагах ?
- Если вам нужна помощь, спросите на обсуждениях!
- Если вы найдете какие -либо улучшения в этом проекте, сообщите нам об этом через проблемы!
Независимо от того, насколько маленьким мы приветствуем?
настраивать:
- Если у вас нет учетной записи GitHub, пожалуйста, создайте ее через регистрацию.
- И при необходимости мы рекомендуем вам сначала сделать учебник Hello Hello World для начинающих.
- Если токен доступа, который заменяет пароль, не установлен, может возникнуть ошибка во время клона.
- В этом случае см. Настройку токенов доступа GitHub.
Шаг 1: разветвляется этот репозиторий
- Вилка этого хранилища, нажав кнопку «Вилка» в правом верхнем углу страницы проекта (эта страница) на GitHub.
- Затем нажмите кнопку «Создать вилку».
- Все элементы, такие как «имя репозитория», «Описание» и «Скопировать только
main филиал», - это нормально, как в исходном формате!
Кончик
Это создаст копию этого репозитория в вашей учетной записи GitHub?
Шаг 2: клон на локальную машину
Вы также можете отредактировать файл на GitHub,
Скопируйте разветвленный репозиторий на местную машину для более общего опыта рабочего процесса.
- На GitHub перейдите на страницу репозитория разветвления, нажмите кнопку «Зеленый код» и скопируйте URL HTTPS.
- Ваш URL должен выглядеть следующим образом:
https://github.com/<あなたのアカウント名>/first-contributions-ja.github.io.git
- Откройте терминал и перейдите в каталог, где вы хотите клонировать репозиторий.
- Например, если вы хотите указать пункт назначения клона на рабочем столе, вы можете использовать следующую команду:
- Используйте следующую команду, чтобы клонировать разветвленный репозиторий на локальную машину:
git clone 先ほどコピーしたクローンURL
Кончик
Это позволяет скопировать хранилище в местную машину и работать в местной среде
Шаг 3: Создайте рабочую ветвь
Перейдите в каталог хранилища со следующей командой:
cd first-contributions-ja.github.io
Установите пакеты, необходимые для этого проекта со следующей командой:
Примечание: что такое NPM? ❓❓
При установленной Node.js запустите команду npm install , чтобы установить библиотеки, необходимые для этого проекта оптом.
Что вы можете сделать после установки npm install
- Запустите локальный сервер и проверьте представление в браузере
- После выполнения команды
npm run dev , нажмите на URL -адрес, который представляется для подтверждения
- Автоматическая проверка и формирование кода при совершении совершения
- Запускается с помощью библиотеки под названием Husky
- Он работает автоматически, поэтому нет необходимости выполнять какие -либо команды или выполнять какую -либо работу
Для получения дополнительной информации о команде npm install , см. Здесь!
Примечание) Если node.js не установлен на вашей локальной машине, команда npm install вызовет ошибку.
В этом случае есть два способа справиться с этим .
- Пропустите процедуру
npm install .- Без этой процедуры вы можете иметь минимальный опыт вклада, поэтому, если это сложно, вы можете пропустить его.
- Я хотел бы узнать, сколько людей здесь наткнутся, поэтому было бы очень полезно, если бы вы могли сообщить в своем запросе на привлечение, например, «
npm install не сработала».
- Установить node.js.
- Для инструкций по установке, пожалуйста, обратитесь к следующему веб -сайту:
- Официальный веб -сайт Node.js / Как установить Node.js (macos) Прогейт / Как установить Node.js (Windows) Прогейт
- Если вы хотите узнать больше о node.js, что такое node.js? Почему все используют это? Пожалуйста, обратитесь к Qiita.
- Если вы заинтересованы в разработке Интернета/JavaScript, я рекомендую использовать эту возможность для ее установки?
- Затем создайте новую филиал, чтобы отделить вашу работу от
main ветви вашего проекта.- Вы можете использовать следующую команду:
git switch -c <ブランチ名> - Имена филиалов - это значимые имена, которые связаны с работой, которую вы собираетесь выполнить. Так что это похоже на это:
git switch -c add-yourname
- ?Примечание )
- Не забудьте заменить
yourname на ручку - Пожалуйста, введите название ветви в буквенно-цифровых персонажах полугодности без Хираганы, Кандзи или Белых помещений.
- : Ogino Chihiro, Ogino Chihiro
- пример:
git switch -c add-oginochihiro
Кончик
Это делает вас готовым вносить изменения, не влияя на main репозиторий проекта?
Шаг 4: Внесите изменения
- Чтобы начать, откройте клонированную папку в вашем любимом редакторе кода, такой как VSCODE.
- Прежде чем внести какие -либо изменения, убедитесь, что вы работаете с филиалом, которую вы создали на предыдущем шаге!
- Вы можете проверить текущую ветку со следующей командой:
- Теперь давайте внесем изменения в файл Antormors.json.
- Скопируйте и вставьте следующий код в «Конец списка» в вашем файле Antormors.json:
,
{
"name": "あなたのハンドルネーム",
"github": "あなたのGitHubアカウントのURL",
"favoriteColor": "あなたの好きなカラーコード",
"favoriteEmoji": "あなたの好きな絵文字"
}
- Затем замените содержимое вставленного текста вашим собственным контентом.
- ? Пожалуйста, обратитесь к следующему веб -сайту: Список эмодзи, основной цветовой словарь, японские традиционные цвета
- Например, если вы замените все это, это будет выглядеть так:
<!-- 変更後 -->
~~
},
{
"name": "oginochihiro",
"github": "https://github.com/first-contributions-ja",
"favoriteColor": "#ffffff",
"favoriteEmoji": "?"
}
]
Шаг 5: Комплексные изменения
- Вернитесь к терминалу и используйте следующую команду, чтобы совершить изменения в локальном репозитории:
- Не забудьте заменить
yourname своим именем ручки.
git add .
git commit -m "yournameをコントリビューターに追加"
Кончик
Это будет регистрировать любые изменения, которые вы вносите в свой файл Antormors.json
Шаг 6: Нажмите изменения
- Изменение изменений в раздробленном удаленном хранилище:
Кончик
Это позволит коммиты, которые вы упомянули ранее (локальные изменения) в ваш удаленный репозиторий на GitHub?
Шаг 7: Создайте запрос на вытяжение (PR)
- Перейдите на страницу с раздробленным удаленным репозиторием на github (
https://github.com/あなたのアカウント/first-contributions-ja.github.io ). - Нажмите кнопку «Сравнить и протянуть запрос» в верхней части.
- Затем, после подтверждения следующего, нажмите кнопку «Создать запрос на развлечение».
- Просто чтобы быть в безопасности, убедитесь, что вы отправляетесь из ветви вашего репозитория
add-yourname в main ветвь первых капитальных JS! - Название остается как начальный ввод, и описание пусто!
Кончик
Это потребует, чтобы любые изменения, которые вы внесли, разветвлялись, были отражены в репозитории, из которого вы распадаетесь?
Шаг 8: Отвечая на отзывы и отзывы
Ваш PR будет рассмотрен (подтвержден) сопровождающим проекта.
- Для рецензентов довольно нормально просить об изменениях в PR. Если это произойдет, сделайте коррекцию, так как это обычное явление.
- В этом случае вы просто возвращаетесь в ту же рабочую филиал, что и раньше, и вносите запрошенные модификации, просто совершайте и продвигаете изменения таким же образом.
- PR будет автоматически обновлен с новым толчком.
Большинство отзывов будут сделаны в течение 24 часов, но могут быть задержки в течение нескольких дней. Пожалуйста, ждите терпеливо ☕
Заканчивать:?
- После того, как запрос на притяжение будет одобрен, любые изменения, которые вы вносят, будут объединены в основной проект.
Спасибо за тяжелую работу!
И спасибо за ваше время и усилия, чтобы внести свой вклад в первый вклад JA! !
Больше шагов
Важный
Если вы найдете этот проект полезным, нажмите кнопку Star из верхней части страницы!
Кроме того, поделитесь со своими подписчиками и знакомыми, чтобы распространить этот проект!
Вы научились внести свой вклад в проекты с открытым исходным кодом!
- Посмотрите на работу, которую вы проделали, и сохраните свои знания на месте.
- Вы только что завершили стандартный рабочий процесс, который вы часто испытываете в качестве участника: прочитайте документацию → Fork → внести изменения → запрос на вытягивание !
- Первый вклад JA - это проект с открытым исходным кодом, поэтому вы можете внести свой вклад другим способом, чем руководство выше.
- Пожалуйста, дайте нам знать, что вы думаете об этом проекте по обсуждению?
- Если вы заинтересованы, проверьте другие взносы.
- Пожалуйста, также внесите вклад в другие проекты с открытым исходным кодом!
- Проверьте темы для начинающих на GitHub (первые выплаты и хорошие результаты)!
- Если у вас есть репозиторий, в который вы хотите внести свой вклад, ищите проблемы, помеченные « Хороший первый вопрос ».
- Обычно это представляет собой проблему для начинающих, которые являются новичками в конкретных проектах или самого открытого исходного кода!
Другие вклад
Если вы хотите внести больше вкладов, пожалуйста, обратитесь к руководящим принципам взноса!
Любые небольшие вклады, такие как добавление кода, исправление ошибок, улучшение документации, приветствуются?
лицензия
Этот проект лицензирован по лицензии MIT.
Благодарности
Этот проект включает в себя первые средства и внести свой вклад в этот проект.
На него влияет отличный проект с открытым исходным кодом, предназначенный для начинающих.
