From 81f4145a88f60d6ee6ac2d18586ad231574041b0 Mon Sep 17 00:00:00 2001 From: azimafroozeh Date: Mon, 8 Sep 2025 13:25:56 +0200 Subject: [PATCH 1/4] add CONTRIBUTING.md --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..59f9c24b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# 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: + ```bash + 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: + + ```bash + 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! \ No newline at end of file From e40bd4c8607e063fe74089eaff238861534a0621 Mon Sep 17 00:00:00 2001 From: azimafroozeh Date: Mon, 8 Sep 2025 13:30:56 +0200 Subject: [PATCH 2/4] put the contributing guidelines in the README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 8055e182..4e3c07f7 100644 --- a/README.md +++ b/README.md @@ -190,6 +190,13 @@ This project is released under the [MIT License](LICENSE). --- +## Contributing + +We welcome contributions to FastLanes! +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to get started. + +--- + ## Join Our Community Come discuss FastLanes, share feedback, and help shape the future of data formats on Discord: From 3eb7069ac29b3f650f2c13dcb2b57ff4bc0a2556 Mon Sep 17 00:00:00 2001 From: azimafroozeh Date: Mon, 8 Sep 2025 15:41:48 +0200 Subject: [PATCH 3/4] bump the seed --- test/src/quick_fuzz_tests/fuzz_config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/src/quick_fuzz_tests/fuzz_config.json b/test/src/quick_fuzz_tests/fuzz_config.json index 2ddec430..159fa6cb 100644 --- a/test/src/quick_fuzz_tests/fuzz_config.json +++ b/test/src/quick_fuzz_tests/fuzz_config.json @@ -1,6 +1,6 @@ { "num_cases": 10, - "base_seed": 8, + "base_seed": 9, "delimiter": "|", "min_cols": 1, "max_cols": 2, From 27d084c69cb87d8ab9b24aa7823879ff7f006222 Mon Sep 17 00:00:00 2001 From: azimafroozeh Date: Mon, 8 Sep 2025 16:08:07 +0200 Subject: [PATCH 4/4] give the credit of PR to who opened not who merged. --- .github/workflows/discord-notify.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/discord-notify.yml b/.github/workflows/discord-notify.yml index c6156b60..28d1b792 100644 --- a/.github/workflows/discord-notify.yml +++ b/.github/workflows/discord-notify.yml @@ -33,16 +33,16 @@ jobs: "${{ github.event.action }}" == "closed" && \ "${{ github.event.pull_request.merged }}" == "true" ]]; then # merged PR metadata - MERGER=$(jq -r '.pull_request.merged_by.login' < "$GITHUB_EVENT_PATH") PR_NUMBER=$(jq -r '.pull_request.number' < "$GITHUB_EVENT_PATH") PR_TITLE=$(jq -r '.pull_request.title' < "$GITHUB_EVENT_PATH") PR_URL=$(jq -r '.pull_request.html_url' < "$GITHUB_EVENT_PATH") BASE_REF=$(jq -r '.pull_request.base.ref' < "$GITHUB_EVENT_PATH") - PR_BODY=$(jq -r '.pull_request.body' < "$GITHUB_EVENT_PATH") + PR_BODY=$(jq -r '.pull_request.body // ""' < "$GITHUB_EVENT_PATH") + OPENER=$(jq -r '.pull_request.user.login' < "$GITHUB_EVENT_PATH") - # assemble a 4-line message: header / title / URL / body + # header / title / URL / body printf -v MSG '%s\n%s\n%s\n\n%s' \ - "📦 PR #${PR_NUMBER} merged into **${BASE_REF}** by **${MERGER}**" \ + "📦 PR #${PR_NUMBER} merged into **${BASE_REF}** — credit goes to [@${OPENER}](https://github.com/${OPENER})" \ "**${PR_TITLE}**" \ "${PR_URL}" \ "${PR_BODY}"