Pull request guidelines¶
Pull requests (PRs) are the mechanism for contributing to FastF1s code and documentation.
Every new feature should be documented. If it’s a new module, don’t forget to add a new rst file to the API docs.
Each high-level plotting function should have a small example in the
Examplessection of the docstring. This should be as simple as possible to demonstrate the method. More complex examples should go into a dedicated example file in the
examplesdirectory, which will be rendered to the examples gallery in the documentation.
Build the docs and make sure all formatting warnings are addressed.
See Writing documentation for our documentation style guide.
If your change is a major new feature, update
Whenever a pull request is created or updated, various automated test tools will run on all supported platforms and versions of Python.
Make sure that all test are passing. (All checks are listed at the bottom of the GitHub page of your pull request)