Skip to content

Commit 8cf6441

Browse files
committed
Minor corrections and verified and updated links
1 parent 7219f21 commit 8cf6441

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

CONTRIBUTING.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ Contribution guidelines
33

44
These guidelines instruct how to submit issues and contribute code to
55
the `SeleniumLibrary project`_. Other great ways to contribute include
6-
answering questions and participating discussion on #seleniumlibrary channel
7-
within the community `Robot Framework Slack`_, the `Robot Framework Forum`_
8-
and other forums as well as spreading the word about the framework one way
9-
or the other.
6+
answering questions and participating in discussions within the
7+
#seleniumlibrary channel on the community `Robot Framework Slack`_, the
8+
`Robot Framework Forum`_ and other channels as well as spreading the word
9+
about the framework one way or the other.
1010

1111
Submitting issues
1212
=================
@@ -107,7 +107,7 @@ in the mean time but are not forcing this as a requirement for accepting
107107
pull requests.
108108

109109
SeleniumLibrary uses the general Python code conventions defined in
110-
`PEP-8`_. In addition to that, we try to write `idiomatic Python`_
110+
`PEP-8`_. In addition to that, we try to write `idiomatic Python`_ or `"Pythonic" code`_
111111
and follow the `SOLID principles`_. with all new code. An important guideline
112112
is that the code should be clear enough that comments are generally not needed.
113113

@@ -169,26 +169,26 @@ When submitting a pull request with a new feature or a fix, you should
169169
always include tests for your changes. These tests prove that your
170170
changes work, help prevent bugs in the future, and help document what
171171
your changes do. Depending an the change, you may need
172-
``acceptance tests``\ *, ``unit tests``* or both.
172+
``acceptance tests``\ *, ``unit tests`` or both.
173173
174174
Make sure to run all of the tests before submitting a pull request to be
175175
sure that your changes do not break anything. If you can, test in
176176
multiple browsers and versions (Firefox, Chrome, IE, Edge etc). Pull requests
177-
are also automatically tested on `Travis CI`_.
177+
are also automatically tested on `GitHub Actions`_.
178178

179179
Acceptance tests
180180
~~~~~~~~~~~~~~~~
181181

182182
Most of SeleniumLibrary's testing is done using acceptance tests that
183183
naturally use Robot Framework itself for testing. Every new
184184
functionality or fix should generally get one or more acceptance tests.
185+
For more details on acceptance tests see `atest/README.rst`_.
185186

186187
Unit tests
187188
~~~~~~~~~~
188189

189190
Unit tests are great for testing internal logic and should be added when
190-
appropriate. For more details see `Unit and acceptance
191-
tests <https://github.com/robotframework/SeleniumLibrary/blob/master/BUILD.rst#unit-and-acceptance-tests%3E>`__.
191+
appropriate. For more details on unit tests see `utest/README.rst`_.
192192

193193
Continuous integration
194194
----------------------
@@ -208,7 +208,7 @@ Acknowledgments
208208
~~~~~~~~~~~~~~~
209209

210210
If you have done any non-trivial change and would like to be credited,
211-
remind us to add `acknowledge` tag to the issue. This way we will add
211+
remind us to add ``acknowledge`` tag to the issue. This way we will add
212212
your name to the release notes, when next release is made.
213213

214214
Resolving conflicts
@@ -229,7 +229,8 @@ the same code as your changes. In that case you should
229229
.. _fork a repository: https://help.github.com/articles/fork-a-repo/
230230
.. _use pull requests: https://help.github.com/articles/using-pull-requests
231231
.. _PEP-8: https://www.python.org/dev/peps/pep-0008/
232-
.. _idiomatic Python: http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html
232+
.. _idiomatic Python: https://en.wikibooks.org/wiki/Python_Programming/Idioms
233+
.. _"Pythonic" code: https://docs.python-guide.org/writing/style/
233234
.. _SOLID principles: https://en.wikipedia.org/wiki/SOLID_(object-oriented_design)
234235
.. _PEP-257: https://www.python.org/dev/peps/pep-0257/
235236
.. _invoke: http://www.pyinvoke.org/
@@ -239,4 +240,4 @@ the same code as your changes. In that case you should
239240
.. _sync your fork: https://help.github.com/articles/syncing-a-fork/
240241
.. _resolve conflicts: https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line
241242
.. _Black: https://github.com/psf/black
242-
.. _flake8: https://gitlab.com/pycqa/flake8
243+
.. _flake8: https://github.com/PyCQA/flake8

0 commit comments

Comments
 (0)