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

Report a bug Request a feature Contribute code Write documentation

• Contributing
  • Submitting a bug report
  • Requesting a new feature
  • Contributing code
  • Contributing documentation
  • Coding guidelines
• Setting up FastF1 for development
  • Creating a dedicated environment
  • Retrieving the latest version of the code
  • Installing FastF1 in editable mode
  • Installing additional dependencies for development
  • Installing pre-commit hooks
• Testing
  • Requirements
  • Running the tests
  • Linting - Code style tests
  • Github Actions CI Tests
• Writing documentation
  • Getting started
• Pull request guidelines
  • Summary for PR authors
  • Detailed guidelines

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.