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