Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contribution guide #1881

Merged
merged 6 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion BUILD.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ Testing
-------

Make sure that adequate tests are executed before releases are created.
See `<test/README.rst>`_ for details.
For more information about unit tests see `<utest/README.rst>`_ or for
acceptance tests see `<atest/README.rst>`_.

Preparation
-----------
Expand Down
77 changes: 48 additions & 29 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,22 @@ Contribution guidelines

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

Submitting issues
=================

Bugs and enhancements are tracked in the `issue tracker`_.
If you are unsure if something is a bug or is a feature worth
implementing, you can first ask on `robotframework-users`_ list. This and
implementing, you can first ask within the `Robot Framework Slack`_. This and
other similar forums, not the issue tracker, are also places where to ask
general questions.

Before submitting a new issue, it is always a good idea to check is the
same bug or enhancement already reported. If it is, please add your
Before submitting a new issue, it is always a good idea to check if the
same bug or enhancement is already reported. If it is, please add your
comments to the existing issue instead of creating a new one.

Reporting bugs
Expand All @@ -43,9 +44,11 @@ Enhancement requests

Describe the new feature and use cases for it in as much detail as
possible in an issue. Especially with larger enhancements, be prepared to
contribute the code in form of a pull request as explained below or to
contribute the code in the form of a pull request as explained below or to
pay someone for the work. Consider also would it be better to implement this
functionality as a separate library outside the SeleniumLibrary.
functionality as a separate library outside the SeleniumLibrary. One option
here is to extend SeleniumLibrary using the public API or plug-in api. Please
see `extending documentation`_ for more details.

Code contributions
==================
Expand Down Expand Up @@ -88,17 +91,25 @@ We do, however, recommend to create dedicated branches for pull requests
instead of creating them based on the master branch. This is especially
important if you plan to work on multiple pull requests at the same time.

This project requires that pull request contains linear history of commits and
we do not allow that pull request contains merge commits or other noise. This helps
the review process and makes the maintenance easier for the project administrators.
Generally it is recommended to do `git pull --rebase` instead of the `git pull --merge`
when there is need pull changes from upstream.
This project asks that prior to making an enhancement pull request that you
discuss the enhancement with the team. We wish to avoid having you spend effort on an
ehancement that won't match with the project. We require that a pull request contains
linear history of commits and we do not allow that pull request contains merge commits
or other noise. This helps the review process and makes the maintenance easier for the
project administrators. Generally it is recommended to do `git pull --rebase` instead
of the `git pull --merge` when there is need pull changes from upstream.

Coding conventions
------------------

The SeleniumLibrary team is currently reviewing, revising, and updating
the coding conventions during Q1 2024. Knowing these coding conventions
are seen as a good practice, we are leaving these here as recommendations
in the mean time but are not forcing this as a requirement for accepting
pull requests.

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

Expand Down Expand Up @@ -145,7 +156,7 @@ individual keywords.

- All new enhancements or changes should have a note telling when the
change was introduced. Often adding something like
``New in SeleniumLibray 1.8.`` is enough.
``New in SeleniumLibrary 1.8.`` is enough.

Keyword documentation can be easily created using `invoke`_ task::

Expand All @@ -159,34 +170,38 @@ Tests
When submitting a pull request with a new feature or a fix, you should
always include tests for your changes. These tests prove that your
changes work, help prevent bugs in the future, and help document what
your changes do. Depending an the change, you may need
``acceptance tests``\ *, ``unit tests``* or both.
your changes do. Depending an the change, you may need ``acceptance tests``,
``unit tests`` or both.

Make sure to run all of the tests before submitting a pull request to be
sure that your changes do not break anything. If you can, test in
multiple browsers and versions (Firefox, Chrome, IE, Edge etc). Pull requests
are also automatically tested on `Travis CI`_.
are also automatically tested on `GitHub Actions`_.

Acceptance tests
~~~~~~~~~~~~~~~~

Most of SeleniumLibrary's testing is done using acceptance tests that
naturally use Robot Framework itself for testing. Every new
functionality or fix should generally get one or more acceptance tests.
For more details on acceptance tests and how to run the acceptance tests,
see `atest/README.rst`_.

Unit tests
~~~~~~~~~~

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

Continuous integration
----------------------

SeleniumLibrary's continuous integration (CI) servers are visible through
`Travis CI`_. For more details about how to run test and how `Travis CI`_
integration is implemented can be found from the `test/README.rst`_.
SeleniumLibrary uses GitHub Actions as it's continuous integration (CI) server.

.. ToDo: re-add when explanation of GitHUb Actions is written
More details about how `GitHub Actions`_ integration is implemented can be
found within `<.github/CI/README.rst>.

Finalizing pull requests
------------------------
Expand All @@ -198,7 +213,7 @@ Acknowledgments
~~~~~~~~~~~~~~~

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

Resolving conflicts
Expand All @@ -209,22 +224,26 @@ the same code as your changes. In that case you should
`sync your fork`_ and `resolve conflicts`_ to allow for an easy merge.

.. _SeleniumLibrary project: https://github.com/robotframework/SeleniumLibrary
.. _robotframework-users: http://groups.google.com/group/robotframework-users
.. _Robot Framework Slack: https://rf-invite.herokuapp.com/
.. _Robot Framework Forum: https://forum.robotframework.org/c/libraries/lib-seleniumlibrary/11
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues
.. _(SSCCE): http://sscce.org
.. _extending documentation: https://github.com/robotframework/SeleniumLibrary/blob/master/docs/extending/extending.rst
.. _GitHub account: https://github.com/
.. _Git: https://git-scm.com
.. _set up Git: https://help.github.com/articles/set-up-git/
.. _fork a repository: https://help.github.com/articles/fork-a-repo/
.. _use pull requests: https://help.github.com/articles/using-pull-requests
.. _PEP-8: https://www.python.org/dev/peps/pep-0008/
.. _idiomatic Python: http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html
.. _idiomatic Python: https://en.wikibooks.org/wiki/Python_Programming/Idioms
.. _"Pythonic" code: https://docs.python-guide.org/writing/style/
.. _SOLID principles: https://en.wikipedia.org/wiki/SOLID_(object-oriented_design)
.. _PEP-257: https://www.python.org/dev/peps/pep-0257/
.. _invoke: http://www.pyinvoke.org/
.. _Travis CI: https://travis-ci.org/robotframework/SeleniumLibrary
.. _test/README.rst`: https://github.com/robotframework/SeleniumLibrary/blob/master/test/README.rst
.. _GitHub Actions: https://github.com/robotframework/SeleniumLibrary/actions
.. _atest/README.rst: https://github.com/robotframework/SeleniumLibrary/tree/master/atest/README.rst
.. _utest/README.rst: https://github.com/robotframework/SeleniumLibrary/blob/master/utest/README.rst
.. _sync your fork: https://help.github.com/articles/syncing-a-fork/
.. _resolve conflicts: https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line
.. _Black: https://github.com/psf/black
.. _flake8: https://gitlab.com/pycqa/flake8
.. _flake8: https://github.com/PyCQA/flake8