Contribute
==========

You want to add some code to cssselect2, launch its tests or improve its
documentation? Thank you very much! Here are some tips to help you play with
cssselect2 in good conditions.

The first step is to clone the repository, create a virtual environment and
install cssselect2 dependencies.

.. code-block:: shell

   git clone https://github.com/Kozea/cssselect2.git
   cd cssselect2
   python -m venv venv
   venv/bin/pip install .[doc,test]

You can then let your terminal in the current directory and launch Python to
test your changes. ``import cssselect2`` will then import the working directory
code, so that you can modify it and test your changes.

.. code-block:: shell

   venv/bin/python


Code & Issues
-------------

If you’ve found a bug in cssselect2, it’s time to report it, and to fix it if you
can!

You can report bugs and feature requests on `GitHub`_. If you want to add or
fix some code, please fork the repository and create a pull request, we’ll be
happy to review your work.

.. _GitHub: https://github.com/Kozea/cssselect2


Tests
-----

Tests are stored in the ``tests`` folder at the top of the repository. They use
the `pytest`_ library.

You can launch tests using the following command::

  venv/bin/python -m pytest

cssselect2 also uses isort_ to check imports and flake8_ to check the coding
style::

  venv/bin/python -m isort . --check --diff
  venv/bin/python -m flake8 --exclude tests/css-parsing-tests

.. _pytest: https://docs.pytest.org/
.. _isort: https://pycqa.github.io/isort/
.. _flake8: https://flake8.pycqa.org/


Documentation
-------------

Documentation is stored in the ``docs`` folder at the top of the repository. It
relies on the `Sphinx`_ library.

You can build the documentation using the following command::

  venv/bin/sphinx-build docs docs/_build

The documentation home page can now be found in the ``docs/_build/index.html``
file. You can open this file in a browser to see the final rendering.

.. _Sphinx: https://www.sphinx-doc.org/