mirror of
https://github.com/LucasVbr/first-contributions.git
synced 2026-05-13 17:21:50 +00:00
roman shrestha
116 lines
8.3 KiB
Markdown
116 lines
8.3 KiB
Markdown
[](https://github.com/ellerbrock/open-source-badges/)
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://www.codetriage.com/roshanjossey/first-contributions)
|
|
|
|
# First Contributions
|
|
|
|
初めてのことは何でも大変なものです。特に他人と協力する時に、間違うのは気持ちの良いことではありません。しかし、オープンソースにおける活動では協力することが全てです。私たちは初めてオープンソースに貢献する人たちが、簡単に貢献できる方法を学べるようにしたいと考えています。
|
|
|
|
記事を読んだりチュートリアルをやってみることはためになりますが、実際にやってみる方が良いでしょう。このプロジェクトはそのガイダンスを行い、初心者が最初のオープンソースへの貢献を簡単に行えるようにするためのものです。<br>
|
|
初めてのオープンソースへの貢献を行いたい場合、以下の簡単なステップに従ってください。
|
|
|
|
#### *コマンドラインでの操作に慣れていない場合、[グラフィカルなツールでもチュートリアルを行えます。]( #その他のツールを使用したチュートリアル )*
|
|
|
|
<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/fork.png" alt="fork this repository" />
|
|
|
|
まだGitをインストールしていない場合は、[ここ](https://help.github.com/articles/set-up-git/)からインストールしてください
|
|
|
|
## リポジトリをフォーク
|
|
|
|
Forkボタンをクリックしてこのリポジトリをフォークしてください。
|
|
この作業であなたのアカウントにはこのリポジトリのコピーが作られます。
|
|
|
|
## リポジトリをクローン
|
|
|
|
<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/clone.png" alt="clone this repository" />
|
|
|
|
次にフォークしたリポジトリをクローンします。あなたのリポジトリに移動してフォークしたリポジトリを開き*Code*ボタンをクリックした後に*Copy to clipboard*アイコンをクリックしてください。
|
|
|
|
ターミナルを開いて以下のgitコマンドを実行してください：
|
|
|
|
```
|
|
git clone "コピーしたURL"
|
|
```
|
|
"コピーしたURL" (ダブルクオーテーションは除いてください) は先ほどコピーしたリポジトリのURLと置き換えてください。
|
|
|
|
<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/copy-to-clipboard.png" alt="copy URL to clipboard" />
|
|
|
|
例：
|
|
```
|
|
git clone https://github.com/＜あなたのユーザー名＞/first-contributions.git
|
|
```
|
|
`あなたのユーザー名` はご自身のGitHubユーザー名に置き換えてください。この作業でGitHub のリポジトリの内容はあなたのコンピュータに保存されました。
|
|
|
|
## ブランチを作成
|
|
|
|
もしリポジトリのディレクトリにいなければそこまで移動してください。
|
|
|
|
```
|
|
cd first-contributions
|
|
```
|
|
`git switch` コマンドを使用してブランチを作成します：
|
|
```
|
|
git switch -c <add-your-name>
|
|
```
|
|
|
|
例:
|
|
```
|
|
git switch -c add-alonzo-church
|
|
```
|
|
(ブランチの名前には必ずしも*add*が含まれていなければならないわけではありませんが、このブランチの目的があなたの名前をリストに加えることであることを考慮すれば含むのが適切です。)
|
|
|
|
## コードを変更してその変更をコミット
|
|
|
|
テキストエディタで`Contributors.md`ファイルを開いてあなたの名前を追加してください。ただし、ファイルの先頭または最後に追加しないようにしましょう。名前リストの間のどこか好きな場所に、あなたの名前を追加するようにしてください。あなたの名前をファイルに加えたら、ファイルを保存します。
|
|
|
|
<img align="float: right;" width="450" src="https://firstcontributions.github.io/assets/Readme/git-status.png" alt="git status" />
|
|
|
|
プロジェクトディレクトリに移動して`git status`を実行すると、変更がなされたことが確認できると思います。`git add`コマンドを使ってそれらの変更を適用してください。
|
|
```
|
|
git add Contributors.md
|
|
```
|
|
|
|
次に`git commit`コマンドを使ってこれらの変更をコミットします。
|
|
```
|
|
git commit -m "Add <あなたの名前> to Contributors list"
|
|
```
|
|
`<あなたの名前>`をご自身の名前に置き換えてください。
|
|
|
|
## GitHubに変更をpushする
|
|
|
|
`git push`コマンドを使って変更をpushしてください。
|
|
```
|
|
git push origin <ブランチ名>
|
|
```
|
|
`<ブランチ名>`には先ほど作成したブランチ名を入れてください。
|
|
|
|
## レビューのためにプルリクエストを送る
|
|
|
|
GitHub上であなたのリポジトリに行くと、`Compare & pull request`ボタンが表示されます。そのボタンをクリックしてください。
|
|
|
|
<img style="float: right;" src="https://firstcontributions.github.io/assets/Readme/compare-and-pull.png" alt="create a pull request" />
|
|
|
|
プルリクエストを作ってください。
|
|
|
|
<img style="float: right;" src="https://firstcontributions.github.io/assets/Readme/submit-pull-request.png" alt="submit pull request" />
|
|
|
|
すぐに変更がこのプロジェクトのmainブランチにマージされます。マージが終了した際にはその旨のメールが送られます。
|
|
|
|
## 次に何をするべきか
|
|
|
|
おめでとうございます！ コントリビューターとして重要な _フォーク -> クローン -> 編集 -> プルリクエスト_ の基本的なワークフローが完了しました。
|
|
|
|
初めてのオープンソースへの貢献を祝って友達やフォロワーに[このウェブアプリ](https://firstcontributions.github.io/#social-share)を使ってシェアしましょう。
|
|
|
|
さらに練習したい場合は、[コードの貢献](https://github.com/roshanjossey/code-contributions)を確認してください。
|
|
|
|
他のプロジェクトへの貢献を始めましょう。簡単なイシューが立てられているプロジェクトのリストを作りました。ウェブアプリで[プロジェクトリスト](https://firstcontributions.github.io/#project-list)を確認してみてください。
|
|
|
|
### [追加リソース](../additional-material/git_workflow_scenarios/additional-material.md)
|
|
|
|
## その他のツールを使用したチュートリアル
|
|
| <a href="../gui-tool-tutorials/github-desktop-tutorial.md"><img alt="GitHub Desktop" src="https://desktop.github.com/images/desktop-icon.svg" width="100"></a> | <a href="../gui-tool-tutorials/github-windows-vs2017-tutorial.md"><img alt="Visual Studio 2017" src="https://upload.wikimedia.org/wikipedia/commons/c/cd/Visual_Studio_2017_Logo.svg" width="100"></a> | <a href="../gui-tool-tutorials/gitkraken-tutorial.md"><img alt="GitKraken" src="https://firstcontributions.github.io/assets/gui-tool-tutorials/gitkraken-tutorial/gk-icon.png" width="100"></a> | <a href="../gui-tool-tutorials/github-windows-vs-code-tutorial.md"><img alt="VS Code" src="https://upload.wikimedia.org/wikipedia/commons/1/1c/Visual_Studio_Code_1.35_icon.png" width=100></a> | <a href="../gui-tool-tutorials/sourcetree-macos-tutorial.md"><img alt="Sourcetree App" src="https://wac-cdn.atlassian.com/dam/jcr:81b15cde-be2e-4f4a-8af7-9436f4a1b431/Sourcetree-icon-blue.svg" width=100></a> | <a href="../gui-tool-tutorials/github-windows-intellij-tutorial.md"><img alt="IntelliJ IDEA" src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/9c/IntelliJ_IDEA_Icon.svg/512px-IntelliJ_IDEA_Icon.svg.png" width=100></a> |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| [GitHub Desktop](../gui-tool-tutorials/github-desktop-tutorial.md) | [Visual Studio 2017](../gui-tool-tutorials/github-windows-vs2017-tutorial.md) | [GitKraken](../gui-tool-tutorials/gitkraken-tutorial.md) | [Visual Studio Code](../gui-tool-tutorials/github-windows-vs-code-tutorial.md) | [Atlassian Sourcetree](../gui-tool-tutorials/sourcetree-macos-tutorial.md) | [IntelliJ IDEA](../gui-tool-tutorials/github-windows-intellij-tutorial.md) |
|