Contributor Guide
=================

Thank you for your interest in improving this project.
This project is open-source under the `MIT license`_ and
welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

- `Source Code`_
- `Documentation`_
- `Issue Tracker`_
- `Code of Conduct`_

.. _MIT license: https://opensource.org/licenses/MIT
.. _Source Code: https://github.com/hacf-fr/renault-api
.. _Documentation: https://renault-api.readthedocs.io/
.. _Issue Tracker: https://github.com/hacf-fr/renault-api/issues

How to report a bug
-------------------

Report bugs on the `Issue Tracker`_.

When filing an issue, make sure to answer these questions:

- Which operating system and Python version are you using?
- Which version of this project are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?

The best way to get your bug fixed is to provide a test case,
and/or steps to reproduce the issue.


How to request a feature
------------------------

Request features on the `Issue Tracker`_.


Providing samples
-----------------

Providing samples for more vehicles helps us improve the library. If you have a vehicle for which we
do not have the specifications yet, or if you have found a new feature for an existing vehicle, then
please send us the samples.

- Generate a trace.
- Add the json file to the correct `test/fixtures/kamereon` subfolder.
- Ensure that `vin` starts with `VF1AAAA` _(we do not want the real VIN)_
- Ensure that `vehicleDetails.vin` also starts with `VF1AAAA` _(we do not want the real VIN)_
- Ensure that `vehicleDetails.registrationNumber` starts with `REG-` _(we do not want the real registration number)_
- Ensure that `vehicleDetails.radioCode` is equal to `1234` _(we do not want the real radio code)_
- Ensure that the json file passes pre-commit (can be parsed online via https://codebeautify.org/jsonviewer)
- Create a pull request

How to set up your development environment
------------------------------------------

You need Python 3.10+ and the following tools:

- Poetry_
- Nox_
- nox-poetry_

**WARNING**: due to an open issue with Poetry, we recommand that you use the 1.0.10 version. You can install it
with the commmand:

.. code:: console

   $ pipx install poetry==1.0.10

Install the package with development requirements:

.. code:: console

   $ poetry install --extras "cli"

You can now run an interactive Python session,
or the command-line interface:

.. code:: console

   $ poetry run python
   $ poetry run renault-api

.. _Poetry: https://python-poetry.org/
.. _Nox: https://nox.thea.codes/
.. _nox-poetry: https://nox-poetry.readthedocs.io/


How to test the project
-----------------------

Run the full test suite:

.. code:: console

   $ nox

List the available Nox sessions:

.. code:: console

   $ nox --list-sessions

You can also run a specific Nox session.
For example, invoke the unit test suite like this:

.. code:: console

   $ nox --session=tests

Unit tests are located in the ``tests`` directory,
and are written using the pytest_ testing framework.

.. _pytest: https://pytest.readthedocs.io/


How to submit changes
---------------------

Open a `pull request`_ to submit changes to this project.

Your pull request needs to meet the following guidelines for acceptance:

- The Nox test suite must pass without errors and warnings.
- Include unit tests. This project maintains 100% code coverage.
- If your changes add functionality, update the documentation accordingly.

Feel free to submit early, though—we can always iterate on this.

To run linting and code formatting checks before commiting your change, you can install pre-commit as a Git hook by running the following command:

.. code:: console

   $ nox --session=pre-commit -- install

It is recommended to open an issue before starting work on anything.
This will allow a chance to talk it over with the owners and validate your approach.

.. _pull request: https://github.com/hacf-fr/renault-api/pulls
.. github-only
.. _Code of Conduct: CODE_OF_CONDUCT.rst
