@@ -154,7 +154,7 @@ individual keywords.
154
154
155
155
- All new enhancements or changes should have a note telling when the
156
156
change was introduced. Often adding something like
157
- ``New in SeleniumLibray 1.8. `` is enough.
157
+ ``New in SeleniumLibrary 1.8. `` is enough.
158
158
159
159
Keyword documentation can be easily created using `invoke `_ task::
160
160
@@ -168,8 +168,8 @@ Tests
168
168
When submitting a pull request with a new feature or a fix, you should
169
169
always include tests for your changes. These tests prove that your
170
170
changes work, help prevent bugs in the future, and help document what
171
- your changes do. Depending an the change, you may need
172
- ``acceptance tests `` \ * , `` unit tests`` or both.
171
+ your changes do. Depending an the change, you may need `` acceptance tests ``,
172
+ ``unit tests `` or both.
173
173
174
174
Make sure to run all of the tests before submitting a pull request to be
175
175
sure that your changes do not break anything. If you can, test in
@@ -182,21 +182,24 @@ Acceptance tests
182
182
Most of SeleniumLibrary's testing is done using acceptance tests that
183
183
naturally use Robot Framework itself for testing. Every new
184
184
functionality or fix should generally get one or more acceptance tests.
185
- For more details on acceptance tests see `atest/README.rst `_.
185
+ For more details on acceptance tests and how to run the acceptance tests,
186
+ see `atest/README.rst `_.
186
187
187
188
Unit tests
188
189
~~~~~~~~~~
189
190
190
191
Unit tests are great for testing internal logic and should be added when
191
- appropriate. For more details on unit tests see `utest/README.rst `_.
192
-
192
+ appropriate. For more details on unit tests and running them, see
193
+ `utest/README.rst `_.
194
+ q
193
195
Continuous integration
194
196
----------------------
195
197
196
- SeleniumLibrary use GitHub Actions as it's continuous integration (CI) server.
197
- For more details about how to run the tests and how `GitHub Actions `_
198
- integration is implemented can be found with the `atest/README.rst `_ for
199
- acceptance tests and `utest/README.rst `_ for unit tests.
198
+ SeleniumLibrary uses GitHub Actions as it's continuous integration (CI) server.
199
+
200
+ .. ToDo: re-add when explanation of GitHUb Actions is written
201
+ More details about how `GitHub Actions`_ integration is implemented can be
202
+ found within `<.github/CI/README.rst>.
200
203
201
204
Finalizing pull requests
202
205
------------------------
0 commit comments