Skip to content

Commit 7219f21

Browse files
committed
First pass on revising the CONTRIBUTING documentation
1 parent 4ba475b commit 7219f21

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

CONTRIBUTING.rst

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,17 @@ 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 `robotframework-users`_
7-
mailing list and other forums as well as spreading the word about the
8-
framework one way or the other.
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.
910

1011
Submitting issues
1112
=================
1213

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

@@ -88,15 +89,23 @@ We do, however, recommend to create dedicated branches for pull requests
8889
instead of creating them based on the master branch. This is especially
8990
important if you plan to work on multiple pull requests at the same time.
9091

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

97100
Coding conventions
98101
------------------
99102

103+
The SeleniumLibrary team is currently reviewing, revising, and updating
104+
the coding conventions during Q1 2024. Knowing these coding conventions
105+
are seen as a good practice, we are leaving these here as recommendations
106+
in the mean time but are not forcing this as a requirement for accepting
107+
pull requests.
108+
100109
SeleniumLibrary uses the general Python code conventions defined in
101110
`PEP-8`_. In addition to that, we try to write `idiomatic Python`_
102111
and follow the `SOLID principles`_. with all new code. An important guideline
@@ -184,9 +193,10 @@ tests <https://github.com/robotframework/SeleniumLibrary/blob/master/BUILD.rst#u
184193
Continuous integration
185194
----------------------
186195

187-
SeleniumLibrary's continuous integration (CI) servers are visible through
188-
`Travis CI`_. For more details about how to run test and how `Travis CI`_
189-
integration is implemented can be found from the `test/README.rst`_.
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.
190200

191201
Finalizing pull requests
192202
------------------------
@@ -209,7 +219,8 @@ the same code as your changes. In that case you should
209219
`sync your fork`_ and `resolve conflicts`_ to allow for an easy merge.
210220

211221
.. _SeleniumLibrary project: https://github.com/robotframework/SeleniumLibrary
212-
.. _robotframework-users: http://groups.google.com/group/robotframework-users
222+
.. _Robot Framework Slack: https://rf-invite.herokuapp.com/
223+
.. _Robot Framework Forum: https://forum.robotframework.org/c/libraries/lib-seleniumlibrary/11
213224
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues
214225
.. _(SSCCE): http://sscce.org
215226
.. _GitHub account: https://github.com/
@@ -222,8 +233,9 @@ the same code as your changes. In that case you should
222233
.. _SOLID principles: https://en.wikipedia.org/wiki/SOLID_(object-oriented_design)
223234
.. _PEP-257: https://www.python.org/dev/peps/pep-0257/
224235
.. _invoke: http://www.pyinvoke.org/
225-
.. _Travis CI: https://travis-ci.org/robotframework/SeleniumLibrary
226-
.. _test/README.rst`: https://github.com/robotframework/SeleniumLibrary/blob/master/test/README.rst
236+
.. _GitHub Actions: https://github.com/robotframework/SeleniumLibrary/actions
237+
.. _atest/README.rst: https://github.com/robotframework/SeleniumLibrary/tree/master/atest/README.rst
238+
.. _utest/README.rst: https://github.com/robotframework/SeleniumLibrary/blob/master/utest/README.rst
227239
.. _sync your fork: https://help.github.com/articles/syncing-a-fork/
228240
.. _resolve conflicts: https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line
229241
.. _Black: https://github.com/psf/black

0 commit comments

Comments
 (0)