1
1
---
2
- title : Contributing to the Selenium Documentation
2
+ title : Seleniumドキュメンテーションに貢献
3
3
disableToc : true
4
4
---
5
5
6
- {{% notice info %}}
7
- <i class =" fas fa-language " ></i > ページは英語から日本語へ訳されています。
8
- 日本語は話せますか?プルリクエストをして翻訳を手伝ってください!
9
- {{% /notice %}}
6
+ Seleniumは大きなソフトウェアプロジェクトです、そしてドキュメンテーションはどのように機能しているかを理解し、ソフトウェアの持ち得る可能性の効果的な利用方法を学ぶための鍵です。
10
7
11
- Selenium is a big software project and documentation is key to
12
- understanding how things work and learning effective ways to exploit
13
- its potential.
8
+ ドキュメンテーションの一部はまだ[ ** www.seleniumhq.org ** リポジトリ] ( https://github.com/SeleniumHQ/www.seleniumhq.org ) から配信されています。
9
+ このドキュメンテーションはSelenium RCと他の旧式の機能にあまりにも重点が置かれているので私達は段階的に廃止し、新しく書き直しをしていきます。
14
10
15
- Part of the documentation of Selenium is still served from our
16
- [ ** www.seleniumhq.org ** repository] ( https://github.com/SeleniumHQ/www.seleniumhq.org ) .
17
- We are however phasing out this documentation which focuses too much
18
- on Selenium RC and other antiquated pieces, in favour of this rewrite.
11
+ この新しいドキュメンテーションプロジェクトはSeleniumのドキュメンテーションを一から書き直すことから始まりました。これは更新されたSeleniumを効果的に使用する為のハンドブックを提供する為の継続的な努力です(特定なリリースを目標するのではない)。私達は古いドキュメンテーションのうちまだ有効なものを移行したいと思っています。
19
12
20
- The new documentation is a project started to rewrite Selenium's
21
- documentation from scratch. This is an ongoing effort (not targetted
22
- at any specific release) to provide an updated handbook on how to use
23
- Selenium effectively. We hope to bring over the pieces of the old
24
- documentation that makes sense.
25
-
26
- Contributions toward the new docs follow the process described in
27
- the below section about contributions. You should spend some time
28
- familiarising yourself with the documentation by reading
29
- [ more about it] ({{< ref "/introduction/about_this_documentation.ja.md" >}}).
13
+ 新しいドキュメンテーションの貢献には下記の貢献についてのセクションに書いてある手順をもとにしてます。多少の時間をかけて読むことによってドキュメンテーションに馴染んでください。
14
+ [ もっと詳しく読む] ({{< ref "/introduction/about_this_documentation.ja.md" >}})
30
15
31
16
---
32
17
33
- The Selenium project welcomes contributions from everyone. There are a
34
- number of ways you can help:
18
+ Seleniumプロジェクトはすべての人からの貢献を歓迎します。手伝うにはいくつかの方法があります:
35
19
36
- ## Report an issue
20
+ ## 課題を報告する
37
21
38
- When reporting a new issues or commenting on existing issues please
39
- make sure discussions are related to concrete technical issues with the
40
- Selenium software and/or its documentation.
22
+ 新たに問題を報告する時や、既存の課題についてコメントする時にはSeleniumソフトウェアそのものかそれに関わるドキュメンテーションの具体的な技術問題に付いてのみ討議するようにしてください。
41
23
42
- All of the Selenium components change quite fast over time, so this
43
- might cause the documentation to be out of date. If you find this to
44
- be the case, as mentioned, don't doubt to create an issue for that.
45
- It also might be possible that you know how to bring up to date the
46
- documentation, so please send us a pull request with the related
47
- changes.
24
+ すべてのSeleniumのコンポーネントは時間と共にかなり早く更新されます、なのでこれがドキュメンテーションを形骸化を招くかもしれません。もしそのようなことを発見した場合には、迷わず問題を報告してください。または、ひょっとしてドキュメンテーションの更新方法を知っているならば、修正点を含むプルリクエストを提出してください。
48
25
49
- If you are not sure about what you have found is an issue or not,
50
- please ask first about it to the
51
- [ selenium-users@ mailing list] ( https://groups.google.com/forum/#!forum/selenium-users ) ,
52
- or join us in the ` #selenium ` channel
53
- on [ irc.freenode.org] ( https://webchat.freenode.net/ ) or [ Slack] ( https://seleniumhq.herokuapp.com/ ) .
26
+ もし、見つけたものが問題かどうか確信がないときは[ selenium-users@ メーリングリスト] ( https://groups.google.com/forum/#!forum/selenium-users ) で質問してください,または[ irc.freenode.org] ( https://webchat.freenode.net/ ) か[ Slack] ( https://seleniumhq.herokuapp.com/ ) の` #selenium ` チャンネルに参加してください。
54
27
55
- ## Contributions
28
+ ## 貢献
56
29
57
- The Selenium project welcomes new contributors. Individuals making
58
- significant and valuable contributions over time are made _ Committers_
59
- and given commit-access to the project.
30
+ Seleniumプロジェクトは新たな貢献者を歓迎します。 重要かつ価値のある貢献をある程度の期間して頂いた方には_コミッター_ (_ Committers_ )になっていただきプロジェクトへのcommit-accessの権限が譲与されます。
60
31
61
- This document will guide you through the contribution process.
32
+ このドキュメンテーションは貢献プロセスを案内します。
62
33
63
- ### Step 1: Fork
34
+ ### ステップ 1: フォーク ( _ Fork _ )
64
35
65
- Fork the project [ on Github] ( https://github.com/seleniumhq/docs )
66
- and check out your copy locally.
36
+ [ Github] ( https://github.com/seleniumhq/docs ) のプロジェクトをフォークして
37
+ ローカル環境にチェックアウトしてください。
67
38
68
39
``` shell
69
40
% git clone git@github.com:username/docs.git
@@ -73,124 +44,93 @@ and check out your copy locally.
73
44
74
45
https://gohugo.io/getting-started/installing/
75
46
76
- #### Dependencies: Hugo
47
+ #### 依存関係: ヒューゴ ( Hugo)
77
48
78
- The docs use [ Hugo] ( https://gohugo.io/ ) to build and render the site.
79
- To verify everything locally before even commiting any changes, please
80
- [ install Hugo] ( https://gohugo.io/getting-started/installing/ ) and
81
- [ run the local server] ( https://gohugo.io/getting-started/usage/#livereload )
82
- to render the site locally.
49
+ ドキュメンテーションは[ ヒューゴ (Hugo)] ( https://gohugo.io/ ) を用いてサイトの生成とレンダーしています。
50
+ 変更点をコミットする前にすべてをローカル環境で確認するために、
51
+ [ ヒューゴ (Hugo)をインストール] ( https://gohugo.io/getting-started/installing/ ) して
52
+ サイトをローカル環境でレンダーするために[ ローカルサーバーを実行] ( https://gohugo.io/getting-started/usage/#livereload ) してください。
83
53
84
- ### Step 2: Branch
54
+ ### ステップ 2:ブランチ ( _ Branch _ )
85
55
86
- Create a feature branch and start hacking :
56
+ フィーチャーブランチを作成して、取り組み始める :
87
57
88
58
``` shell
89
59
% git checkout -b my-feature-branch
90
60
```
91
61
92
- We practice HEAD-based development, which means all changes are applied
93
- directly on top of master.
62
+ 私達はHEAD-based開発を実践しています、すなわち全ての変更はmaster上に直接反映されます。
94
63
95
- ### Step 3: Commit
64
+ ### ステップ 3:コミット( _ Commit _ )
96
65
97
- First make sure git knows your name and email address :
66
+ 初めにgitにあなたの名前とメールアドレスを登録済みか確認してください :
98
67
99
68
``` shell
100
69
% git config --global user.name ' Santa Claus'
101
70
% git config --global user.email ' santa@example.com'
102
71
```
103
72
104
- ** Writing good commit messages is important.** A commit message
105
- should describe what changed, why, and reference issues fixed (if
106
- any). Follow these guidelines when writing one:
73
+ ** 良質なコミットメッセージを書くことは重要です。** コミットメッセージには変更点、理由、修正したissueへの参照(もし存在するならば)を記述すべきです。コミットメッセージを書く時には次のガイドラインに従ってください:
107
74
108
- 1 . The first line should be around 50 characters or less and contain a
109
- short description of the change.
110
- 2 . Keep the second line blank.
111
- 3 . Wrap all other lines at 72 columns.
112
- 4 . Include ` Fixes #N ` , where _ N_ is the issue number the commit
113
- fixes, if any.
75
+ 1 . 1行目は50字以内で、変更内容の要約を含める。
76
+ 2 . 2行目は空行にする。
77
+ 3 . 各行を72列で改行する。
78
+ 4 . もしあるならば` Fixes #N ` を含める, 但し_N_はこのコミットが修正するissueナンバーです。
114
79
115
- A good commit message can look like this :
80
+ 良質なコミットメッセージとはこんな感じです :
116
81
117
82
``` text
118
- explain commit normatively in one line
83
+ 一行でコミットを規範的に説明する
119
84
120
- Body of commit message is a few lines of text, explaining things
121
- in more detail, possibly giving some background about the issue
122
- being fixed, etc.
85
+ コミットメッセージの本文は2〜3行でより詳しく説明し、修正されるissueに
86
+ ついての背景など可能な限り入れます。
123
87
124
- The body of the commit message can be several paragraphs, and
125
- please do proper word-wrap and keep columns shorter than about
126
- 72 characters or so. That way `git log` will show things
127
- nicely even when it is indented.
88
+ コミットメッセージいくつかのパラグラフになる場合があります、そして正し
89
+ く改行して、一行が72文字以内になるよう努めてください。そうすると
90
+ `git log`がインデントされていてもきれいに表示されます。
128
91
129
92
Fixes #141
130
93
```
131
94
132
- The first line must be meaningful as it's what people see when they
133
- run ` git shortlog ` or ` git log --oneline ` .
95
+ 一行目は意味のあるものではないといけません、というのは` git shortlog ` 又は` git log --oneline ` を実行したときに人に見えるものだからです。
134
96
135
- ### Step 4: Rebase
97
+ ### ステップ 4: リーベース( _ Rebase _ )
136
98
137
- Use ` git rebase ` (not ` git merge ` ) to sync your work from time to time.
99
+ ( ` git merge ` ではなく) ` git rebase ` を使用してコードの同期化時々します。
138
100
139
101
``` shell
140
102
% git fetch upstream
141
103
% git rebase upstream/master
142
104
```
143
105
144
- ### Step 5: Test
106
+ ### ステップ 5: 検証
145
107
146
- Always remember to [ run the local server] ( https://gohugo.io/getting-started/usage/#livereload ) ,
147
- with this you can be safe that your changes have not broken anything.
108
+ いつも[ ローカルサーバーを実行すること] ( https://gohugo.io/getting-started/usage/#livereload ) を覚えてくださいそうすることで変更点が他の物を壊さない確証が得られます。
148
109
149
- ### Step 6: Translations
110
+ ### ステップ 6: 翻訳
150
111
151
- If you are updating the docs, adding new ones, or deleting deprecated ones, please remember
152
- to update the translations of it. Of course, it is possible that you do not speak all the
153
- translated languages in the docs. For that, please create an
154
- [ issue] ( https://github.com/SeleniumHQ/docs/issues ) where you clearly describe that something
155
- in the docs has changed and its translation needs to be updated. With that, someone who speaks
156
- that needed language can chime in and help us to keep it up to date.
112
+ もし新しいものを付け加えたり、いらなくなったものを削除したりして、ドキュメンテーションを更新するならば翻訳も忘れずに更新してください。もちろんすべての翻訳言語が話せるとは限りませんです。そのような場合には[ 課題(issue)] ( https://github.com/SeleniumHQ/docs/issues ) を作成し、ドキュメンテーション上どこが変更されたのかと翻訳が必要であること明記してください。それによって、その必要な言語が話せるどなたかが立候補してドキュメンテーションが更新され続ける事を手助けしてくれます。
157
113
158
- ### Step 7: Sign the CLA
114
+ ### ステップ 7:CLAに署名する
159
115
160
- Before we can accept, we first ask people to sign a
161
- [ Contributor License Agreement] ( https://spreadsheets.google.com/spreadsheet/viewform?hl=en_US&formkey=dFFjXzBzM1VwekFlOWFWMjFFRjJMRFE6MQ#gid=0 )
162
- (or CLA). We ask this so that we know that contributors have the right
163
- to donate the code.
116
+ 受け入れができる前に、私達は最初に[ 貢献者ライセンス同意書(_ Contributor License Agreement_ )] ( https://spreadsheets.google.com/spreadsheet/viewform?hl=en_US&formkey=dFFjXzBzM1VwekFlOWFWMjFFRjJMRFE6MQ#gid=0 ) (又はCLA)に署名をお願いしています。私達がお願いするのには貢献者がコードを寄付する権利を有することを私達が知るためです。
164
117
165
- When you open your pull request we ask that you indicate that you've
166
- signed the CLA. This will reduce the time it takes for us to integrate
167
- it.
118
+ プルリクエストを提出する時にCLA貢献者ライセンス同意書に署名したことを提示してください。そうすると統合させるまでの時間を減らせます。
168
119
169
- ### Step 8: Push
120
+ ### ステップ 8: プッシュ( _ Push _ )
170
121
171
122
``` shell
172
123
% git push origin my-feature-branch
173
124
```
174
125
175
- Go to https://github.com/yourusername/docs.git and press the _ Pull
176
- Request_ and fill out the form. ** Please indicate that you've signed
177
- the CLA** (see Step 6).
126
+ https://github.com/yourusername/docs.git へ行き _ PullRequest_ を押して、フォームに記入します。** CLAに署名したことを提示してください** (ステップ 6参照)。
178
127
179
- Pull requests are usually reviewed within a few days. If there are
180
- comments to address, apply your changes in new commits (preferably
181
- [ fixups] ( http://git-scm.com/docs/git-commit ) ) and push to the same
182
- branch.
128
+ 通常プルリクエストは2−3日中にレビューされます。もし処理しなくてはいけないコメントがあるならば、新たなコミット(_ commit_ )に修正箇所を含めます。(なるべく[ フィックスアップ(_ fixups_ )] ( http://git-scm.com/docs/git-commit ) を使用する)そして同じブランチ(_ branch_ )にプッシュ(_ push_ )します。
183
129
184
- ### Step 9: Integration
130
+ ### ステップ 9: 統合
185
131
186
- When code review is complete, a committer will take your PR and
187
- integrate it on the docs's gh-pages branch. Because we like to keep a
188
- linear history on the master branch, we will normally squash and rebase
189
- your branch history.
132
+ コードレビュー終了した時に、_ コミッター_ (_ Committers_ )がPR(プルリクエスト)を受取り、ドキュメントのgh-pagesブランチと統合させます。masterブランチの履歴を一本線で維持したいので、スクワッシュ(_ squash_ )とリーベース(_ rebase_ )をあなたのブランチに対して通常行います。
190
133
191
- ## Communication
134
+ ## コミュニケーション
192
135
193
- Selenium contributors frequent the ` #selenium ` channel on
194
- [ ` irc.freenode.org ` ] ( https://webchat.freenode.net/ ) or on
195
- or [ Slack] ( https://seleniumhq.herokuapp.com/ ) . You can also join
196
- the [ ` selenium-developers@ ` mailing list] ( https://groups.google.com/forum/#!forum/selenium-developers ) .
136
+ Seleniumの貢献者は頻繁に[ ` irc.freenode.org ` ] ( https://webchat.freenode.net/ ) や[ Slack] ( https://seleniumhq.herokuapp.com/ ) の` #selenium ` チャンネルに集まります。[ ` selenium-developers@ ` メーリングリスト] ( https://groups.google.com/forum/#!forum/selenium-developers ) にも参加することができます。
0 commit comments