.. _developers-guide-index:

############
Contributing
############

Thank you for your interest in helping to improve FastF1! There are various
ways to contribute to FastF1. All of them are super valuable but don't
necessarily require writing code at all. For example:

- contributing to the documentation
- opening new issues for bugs
- requesting new features
- asking for clarification on things you find unclear
- fixing bugs
- writing example scripts for the gallery


.. raw:: html

   <div style="margin: 2em 0">
     <a href="contributing.html#submitting-a-bug-report"><span class="ff1-button">Report a bug</span></a>
     <a href="contributing.html#request-a-new-feature"><span class="ff1-button">Request a feature</span></a>
     <a href="contributing.html#contributing-code"><span class="ff1-button">Contribute code</span></a>
     <a href="contributing.html#contributing-documentation"><span class="ff1-button">Write documentation</span></a>
   </div>

.. toctree::
   :maxdepth: 2

   contributing.rst
   devenv_setup.rst
   testing.rst
   documenting_fastf1.rst
   coding_guide.rst


**Acknowledgement**: This contribution guide is heavily based on and in large
parts copied over and adapted from Matplotlibs documentation. There's no need
to reinvent the wheel if others have done a great job of explaining things
already.