1
1
---
2
2
title : コンテンツの提出
3
- description : GitHub UI またはローカルのフォークを利用して 、新しいコンテンツまたはコンテンツの変更を提出する方法を学びます
3
+ description : GitHub UI 利用して、またはローカルのフォークから 、新しいコンテンツまたはコンテンツの変更を提出する方法を学びます
4
4
aliases : [new-content]
5
5
weight : 15
6
- default_lang_commit : 99f0ae5760038d51f9e9eb376bb428a2caca8167 # patched
7
- drifted_from_default : true
6
+ default_lang_commit : 94d77ab8cbfe5552a7cd68bf677be86c574a613a
8
7
---
9
8
10
- 新しいドキュメントの内容を追加したり、既存のコンテンツの改善をするには 、[ プルリクエスト] [ PR ] (PR)を提出してください。
9
+ 新しいドキュメントの内容を追加や改善するには 、[ プルリクエスト] [ PR ] (PR)を提出してください。
11
10
12
- - もし変更が小さかったり、自身が Git に慣れていなかったら、[ GitHub を使用した変更] ( #changes-using-github ) を参照しページの編集方法を学んでください。
13
- - もし変更が大きければ、[ ローカルのフォークから作業する] ( #fork-the-repo ) を参照し、ローカルのコンピュータから変更を行う方法を学んでください。
11
+ - もし変更が小さかったり、自身が [ Git] に慣れていなかったら、[ GitHub を使用] ( #changes-using-github ) を参照しページの編集方法を学んでください。
12
+ - もしくは、[ ローカルのフォークから作業する] ( #fork-the-repo ) を参照し、ローカルのコンピュータから変更を行う方法を学んでください。
13
+
14
+ {{% alert title="Contributor License Agreement (CLA)" color=warning %}}
15
+
16
+ All contributors are required to [ sign a Contributor License Agreement
17
+ (CLA)] [ CLA ] before changes can be reviewed and merged.
18
+
19
+ [ CLA ] : ../prerequisites/#cla
20
+
21
+ {{% /alert %}}
14
22
15
23
{{% alert title="ヒント: Draft ステータス" %}}
16
24
@@ -42,19 +50,13 @@ class first,second white
42
50
43
51
_ 図 1. 新しいコンテンツにコントリビュートする。_
44
52
45
- ## GitHub を使用した変更 {#changes-using-github}
53
+ ## GitHub を使用 {#changes-using-github}
54
+
55
+ ### ブラウザから修正し変更を提出する {#page-edit-from-browser}
46
56
47
57
もし、Git のワークフローをあまり慣れていなければ、プルリクエストを作成して提出するより簡単な方法があります。
48
58
図 2 は手順の概要を示しており、詳細はこの後に続きます。
49
59
50
- {{% alert title="Contributor License Agreement (CLA)" color=warning %}}
51
-
52
- すべてのコントリビューターは、変更が承認されてマージされる前に、[ コントリビューターライセンス契約(Contributor License Agreement、CLA)] [ CLA ] に署名する必要があります。
53
-
54
- [ CLA ] : ../prerequisites/#cla
55
-
56
- {{% /alert %}}
57
-
58
60
``` mermaid
59
61
flowchart LR
60
62
A([fa:fa-user 新しい<br>コントリビューター]) --- id1[(open-telemetry/opentelemetry.io<br>GitHub)]
@@ -112,17 +114,45 @@ _図 2. GitHub を利用した PR の公開手順。_
112
114
113
115
レビューが完了したら、レビュアーは PR をマージして変更が数分後に反映されます。
114
116
115
- {{% alert title="Tip" %}}
117
+ ### Fixing PR check failures {#fixing-prs-in-github}
118
+
119
+ PR を提出した後に、GitHub はいくつかのビルドチェックを実行します。
120
+ フォーマットの問題といった、特定のチェックの失敗は自動的に修正できます。
121
+
122
+ 以下のコメントを PR に追加してください。
123
+
124
+ ``` text
125
+ /fix:all
126
+ ```
127
+
128
+ これは、OpenTelemetry bot がビルドの問題を修正しようとします。
129
+ もしくは、特定の失敗に対処するために、次の修正コマンドの 1 つを実行できます。
130
+
131
+ ``` text
132
+ fix:dict
133
+ fix:expired
134
+ fix:filenames
135
+ fix:format
136
+ fix:htmltest-config
137
+ fix:i18n
138
+ fix:markdown
139
+ fix:refcache
140
+ fix:submodule
141
+ fix:text
142
+ ```
143
+
144
+ {{% alert title="Pro Tip" %}}
116
145
117
- プルリクエストに ` /fix:format ` とコメントすると、フォーマットの問題を自動的にチェックするトリガーが起動します。
146
+ ` fix ` コマンドをローカルで実行できます。
147
+ 修正コマンドの全リストは、` npm run -s '_list:fix:*' ` を実行してください。
118
148
119
149
{{% /alert %}}
120
150
121
- ## ローカルのフォークから作業する {#fork-the-repo}
151
+ ## ローカルで作業する {#fork-the-repo}
122
152
123
153
Git に慣れている場合もしくは、変更が数行以上の場合は、ローカルのフォークから作業してください。
124
154
125
- [ git] ( https:// git-scm.com/book/en/v2/Getting-Started-Installing-Git ) がパソコンにインストール済みであることを確認してください 。
155
+ パソコンに [ git がインストール済み ] [ ` git` installed ] であることを確認してください 。
126
156
Git のユーザーインターフェースも利用できます。
127
157
128
158
図 3 は、ローカルのフォークから作業するときに従う手順を示しています。詳細はそれぞれの手順に従ってください。
@@ -154,12 +184,12 @@ class changes,changes2 white
154
184
155
185
_ 図 3. ローカルのフォークで作業して変更を追加。_
156
186
157
- ### opentelemetry.io リポジトリをフォークする {#fork-the-opentelemetryio -repository}
187
+ ### リポジトリをフォークする {#fork-the-repository}
158
188
159
189
1 . [ ` opentelemetry.io ` ] ( https://github.com/open-telemetry/opentelemetry.io/ ) リポジトリに移動してください。
160
190
1 . ** フォーク** を選択してください。
161
191
162
- ### ローカルのクローンを作成し、アップストリームを設定してください {#create-a-local- clone-and-set-the -upstream}
192
+ ### クローンし、アップストリームを設定 {#clone-and-set-upstream}
163
193
164
194
1 . ターミナルウィンドウで、フォークをクローンし、必要なものをインストールしてください。
165
195
@@ -259,7 +289,7 @@ _図 3. ローカルのフォークで作業して変更を追加。_
259
289
260
290
1 . 変更がプッシュされると、GitHub が PR を作成できることを知らせます。
261
291
262
- ### フォークからプルリクエストを公開する {#open-a-pr}
292
+ ### 新しいプルリクエストを公開する {#open-a-pr}
263
293
264
294
図 4 はフォークから [ opentelemetry.io] ( https://github.com/open-telemetry/opentelemetry.io ) への PR を開く手順を示しています。
265
295
@@ -314,7 +344,7 @@ PR を公開した後に、自動テストの実行と [Netlify](https://www.net
314
344
315
345
他のチェックも同様に失敗している可能性があります。[ すべての PR チェック] ( ../pr-checks ) を参照してください。
316
346
317
- ### 内容の問題を自動的に修正する {#fix-issues}
347
+ ### 問題を修正する {#fix-issues}
318
348
319
349
リポジトリに変更を提出するまえに、以下のコマンドを実行して (i) 報告された問題の対応し、(ii) スクリプトによって変更されたファイルのコミットをしてください。
320
350
@@ -332,7 +362,7 @@ npm run fix:all # ファイルを更新する場合があります。
332
362
利用可能な NPM スクリプトのリストを表示するには、` npm run ` を実行してください。
333
363
プルリクエストのチェックとエラーの自動修正の詳細は、[ PR checks] ( ../pr-checks ) を参照してください。
334
364
335
- ### 変更をローカルでプレビューする {#preview-locally}
365
+ ### 変更をプレビューする {#preview-locally}
336
366
337
367
変更のプッシュまたはプルリクエストの公開の前に、ローカルでプレビューしてください。
338
368
プレビューはビルドエラーとマークダウンのフォーマットの問題を検出できます。
@@ -343,7 +373,7 @@ Hugo をローカルでビルドと提供するには、以下のコマンドを
343
373
npm run serve
344
374
```
345
375
346
- Web ブラウザで ` http://localhost:1313 ` に移動してローカルプレビューを確認してください。
376
+ Web ブラウザで < http://localhost:1313 > に移動してローカルプレビューを確認してください。
347
377
Hugo は変更を監視し、必要に応じてサイトをリビルドします。
348
378
349
379
ローカルの Hugo インスタンスを停止するには、ターミナルにもどって ` Ctrl+C ` を入力するか、ターミナルを閉じてください。
@@ -465,4 +495,6 @@ PR がマージされる前に、レビューと編集を数回繰り返すこ
465
495
466
496
[ dashboard ] : https://app.netlify.com/sites/opentelemetry/overview
467
497
[ deploy preview ] : https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/
498
+ [ Git ] : https://docs.github.com/en/get-started/using-git/about-git
499
+ [ `git` installed ] : https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
468
500
[ PR ] : https://docs.github.com/en/pull-requests
0 commit comments