Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (39 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

61 lines (39 loc) · 1.44 KB

Contributing to FastLanes

We welcome contributions of all kinds:

  • bug fixes
  • performance improvements
  • documentation
  • new features

This document describes the contribution process and testing requirements.

Getting Started

  1. Fork the repository on GitHub and create a feature branch:

    git checkout -b my-feature

  2. Make your changes, following our coding guidelines (see below).

  3. Run the test suite locally before submitting your PR.

  4. Open a Pull Request (PR) against the dev branch.

Testing

FastLanes includes several layers of testing. All PRs must pass the full test suite in CI.

Fuzzy Tests

FastLanes uses fuzzy tests with an incremental bump seed to check edge cases. To keep results reproducible, the fuzz seed is stored in the repository.

  • Each PR must increment the seed so tests run with a new value.

  • Bump the seed by running:

    make bump

Submitting a PR

  • Open your PR against the dev branch.
  • Make sure your branch is rebased on top of dev before submission.
  • Verify that CI passes (unit tests + fuzzy tests + Python tests if applicable).
  • Keep PRs focused — small, logical changes are easier to review and merge.

Communication

  • For questions, join the FastLanes Discord.
  • Use GitHub Issues for bug reports and feature requests.

Thanks for helping improve FastLanes — we appreciate your contributions!