Skip to content

Code Contributions

Thank you for your interest in contributing to Lyzer! This guide will help you understand how to contribute code to our Formula 1 data analysis project.

Before you start

This section specifically addresses how to contribute code to Lyzer for open issues, ensure to reach out to the maintainers before doing any work to ensure it is in line with the project goals and direction.

Setting Up Your Development Environment

Refer to the development getting started guide for instructions on how to set up your development environment.

Maintainers (Non-maintainers should still read this)

Below we will cover the process of contributing code to Lyzer if you are a maintainer.

Board

We have a board/project for managing issues in GitHub. If you are a maintainer, you should have edit/write access to the board, if you don't, please reach out to the team.

Before picking up an issue, please ensure you have communicated to the team that you will be working on an issue and have assigned yourself to the issue.

For code contributions, you should only be taking issues from the "Todo" column.

Once you start working on an issue, please move the issue to the "In Progress" column.

When you are ready to submit your PR and have it reviewed, please move the issue to the "Ready for Review" column.

A maintainer will review your PR and either approve it or give you feedback.

PRs

When opening a PR, please ensure that your issue is linked to the PR.

  • Ensure all workflows are passing
  • Ensure that you have added tests for your changes
  • Ensure that you have added documentation for your changes
  • Ensure that you have added a description of the changes you have made
  • Ensure that you have assigned yourself to the PR
  • Ensure that you have moved the issue to the "Ready for Review" column
  • Assign reviewers to the PR

Non-maintainers

If you are not a maintainer, you can still contribute to Lyzer by working on open issues.

You will have to communicate your interest to work on the issue with a comment, ensure to tag a maintainer in the comment requesting to work on the issue.

Once you have been assigned to the issue and given verbal confirmation by a maintainer, you can start working on it.

You will likely need to fork the repository to your GitHub account to work on the issue.

Once you have made your changes, you can push your changes to your fork and open a PR into the main repository.

Board

We have a board/project for managing issues in GitHub. If you are not a maintainer, you will have only read access to the board.

This will require you to communicate your interest in working on an issue with a comment, and then a maintainer will need to assign you to the issue and move it for you to start working on it.

It it critical that you communicate the progress of the issue with comments in the issue and PR, and keeping the maintainer updated.

PRs

When opening a PR, please ensure that your issue is linked to the PR.

  • Ensure all workflows are passing
  • Ensure that you have added tests for your changes
  • Ensure that you have added documentation for your changes
  • Ensure that you have added a description of the changes you have made
  • Ensure that you have assigned yourself to the PR
  • Ensure that the maintainer has moved the issue to the "Ready for Review" column
  • Assign reviewers to the PR