From 3bf384e9e411aca983dad5fa6e2413ba69dc20b1 Mon Sep 17 00:00:00 2001
From: Richard Baah <richardbaah@MacBook-Air-de-Richard.local>
Date: Tue, 11 Nov 2025 01:56:26 -0500
Subject: [PATCH] Added lots of configuration and documentation to start the
 project

---
 .github/workflows/go-test.yml                 |  36 ++-
 .github/workflows/rust-test.yml               |  44 ++++
 CONTRIBUTING.md                               | 155 +++++++++++++
 LICENSE.txt                                   | 209 ++++++++++++++++++
 Makefile                                      | 100 +++++++++
 README.md                                     | 136 +++++++++++-
 src/Backend/opti-sql-go/go.mod                |   2 +-
 .../physical-optimizer/optimize.go            |   2 +
 src/Backend/opti-sql-rs/src/main.rs           |   8 +-
 src/Backend/opti-sql-rs/src/project/mod.rs    |   4 +-
 .../opti-sql-rs/src/project/source/csv.rs     |   1 -
 .../opti-sql-rs/src/project/source/json.rs    |   1 +
 .../opti-sql-rs/src/project/source/mod.rs     |   2 +-
 .../opti-sql-rs/src/project/source/parquet.rs |   3 +-
 14 files changed, 685 insertions(+), 18 deletions(-)
 create mode 100644 .github/workflows/rust-test.yml
 create mode 100644 CONTRIBUTING.md
 create mode 100644 LICENSE.txt
 create mode 100644 Makefile

diff --git a/.github/workflows/go-test.yml b/.github/workflows/go-test.yml
index b0d707b..63652ce 100644
--- a/.github/workflows/go-test.yml
+++ b/.github/workflows/go-test.yml
@@ -7,6 +7,23 @@ on:
     branches: [ main ]
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.24'
+    
+    - name: Run golangci-lint
+      uses: golangci/golangci-lint-action@v6
+      with:
+        version: latest
+        working-directory: ./src/Backend/opti-sql-go
+
   test:
     runs-on: ubuntu-latest
     
@@ -16,16 +33,23 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: '1.21'
+        go-version: '1.24'
     
     - name: Run tests
       working-directory: ./src/Backend/opti-sql-go
       run: go test -v ./...
     
-    - name: Run tests with coverage
-      working-directory: ./src/Backend/opti-sql-go
-      run: go test -v -coverprofile=coverage.out ./...
+  race:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: '1.24'
     
-    - name: Display coverage
+    - name: Run tests with race detector
       working-directory: ./src/Backend/opti-sql-go
-      run: go tool cover -func=coverage.out
+      run: go test -race -v ./...
diff --git a/.github/workflows/rust-test.yml b/.github/workflows/rust-test.yml
new file mode 100644
index 0000000..a67656b
--- /dev/null
+++ b/.github/workflows/rust-test.yml
@@ -0,0 +1,44 @@
+name: Rust Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Rust
+      uses: actions-rust-lang/setup-rust-toolchain@v1
+      with:
+        toolchain: stable
+        components: clippy, rustfmt
+    
+    - name: Run clippy
+      working-directory: ./src/Backend/opti-sql-rs
+      run: cargo clippy --all-targets --all-features -- -D warnings
+    
+    - name: Check formatting
+      working-directory: ./src/Backend/opti-sql-rs
+      run: cargo fmt -- --check
+
+  test:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Rust
+      uses: actions-rust-lang/setup-rust-toolchain@v1
+      with:
+        toolchain: stable
+    
+    - name: Run tests
+      working-directory: ./src/Backend/opti-sql-rs
+      run: cargo test --verbose
+    
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..7e5fd6c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,155 @@
+# Contributing to OptiSQL
+
+Thank you for your interest in contributing to OptiSQL! This guide will help you get started.
+
+## How to Write and Run Tests
+
+We use a Makefile to simplify common development tasks. All commands should be run from the project root.
+
+### Go Tests
+- Run all tests
+  ```bash
+  make go-test
+  ```
+- Run tests with race detector
+  ```bash
+  make go-test-race
+  ```
+- Run tests with coverage
+  ```bash
+  make go-test-coverage
+  ```
+
+### Rust Tests
+- Run all tests
+  ```bash
+  make rust-test
+  ```
+
+### Run All Tests (Go + Rust)
+- Run tests for both backends
+  ```bash
+  make test-all
+  ```
+
+## Pull Request (PR) Format
+
+- Create a descriptive PR title that summarizes the change
+- Include the following sections in your PR description:
+  - **What**: Brief description of what this PR does
+  - **Why**: Explanation of why this change is needed
+  - **How**: Technical details of how the change was implemented
+  - **Testing**: How you tested the changes
+- Reference any related issues using `Fixes #<issue-number>` or `Closes #<issue-number>`
+- Ensure all CI checks pass 
+
+## Git Commit Message Format
+
+- Use conventional commit format:
+  ```bash
+  <type>(<scope>): <subject>
+  
+  <body>
+  
+  <footer>
+  ```
+- **Types**: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
+- **Examples**:
+  ```bash
+  feat(operators): add hash join implementation
+  
+  fix(parser): handle edge case in substrait parsing
+  
+  docs(readme): update installation instructions
+  
+  test(filter): add unit tests for wildcard filter
+  ```
+- Keep subject line under 50 characters
+- Capitalize the subject line
+- Use imperative mood ("add" not "added")
+- Separate subject from body with a blank line
+- Wrap body at 72 characters
+
+## Areas Where We Currently Need Help / Open Contributions
+
+- **Operator Implementations**: Help implement missing SQL operators (join, filter, aggregation)
+- **Substrait Integration**: Improve substrait plan parsing and optimization
+- **Test Coverage**: Add unit tests and integration tests for existing functionality
+- **Documentation**: Improve code comments, API documentation, and user guides
+- **Performance Optimization**: Profile and optimize query execution performance
+- **Bug Fixes**: Check the issues tab for open bugs that need fixing
+
+## How to Build, Test, and Run the Application
+
+### Prerequisites
+- Go 1.24 or higher
+- Rust 1.70 or higher
+- Git
+- Make
+
+### Clone the Repository
+```bash
+git clone https://github.com/Rich-T-kid/OptiSQL.git
+cd OptiSQL
+```
+
+### Quick Start with Makefile
+
+See all available commands:
+```bash
+make help
+```
+
+### Build and Run Go Backend
+```bash
+make go-run
+```
+
+### Build and Run Rust Backend
+```bash
+make rust-run
+```
+
+### Run All Tests
+```bash
+make test-all
+```
+
+Or run individually:
+```bash
+make go-test
+make rust-test
+```
+
+### Run Linters
+```bash
+make lint-all
+```
+
+Or run individually:
+```bash
+make go-lint
+make rust-lint
+```
+
+### Format Code
+```bash
+make fmt-all
+```
+
+### Clean Build Artifacts
+```bash
+make clean-all
+```
+
+### Verify CI Pipeline Locally
+Before pushing, run the pre-push check:
+```bash
+make pre-push
+```
+
+This runs formatting, linting, and all tests to ensure your changes will pass CI.
+
+---
+
+For questions or help, please open an issue. 
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..0b5f5c1
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,209 @@
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+This project includes code from Apache Aurora.
+
+* dev/release/{release,changelog,release-candidate} are based on the scripts from
+  Apache Aurora
+
+Copyright: 2016 The Apache Software Foundation.
+Home page: https://aurora.apache.org/
+License: http://www.apache.org/licenses/LICENSE-2.0
\ No newline at end of file
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..0afcce1
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,100 @@
+.PHONY: help go-test rust-test go-run rust-run go-lint rust-lint go-fmt rust-fmt test-all lint-all fmt-all pre-push
+
+# Default target
+help:
+	@echo "Available targets:"
+	@echo "  make go-test       - Run Go tests"
+	@echo "  make rust-test     - Run Rust tests"
+	@echo "  make go-run        - Run Go application"
+	@echo "  make rust-run      - Run Rust application"
+	@echo "  make go-lint       - Run Go linter"
+	@echo "  make rust-lint     - Run Rust linter and formatter check"
+	@echo "  make go-fmt        - Format Go code"
+	@echo "  make rust-fmt      - Format Rust code"
+	@echo "  make test-all      - Run all tests (Go + Rust)"
+	@echo "  make lint-all      - Run all linters (Go + Rust)"
+	@echo "  make fmt-all       - Format all code (Go + Rust)"
+	@echo "  make pre-push      - Run fmt, lint, and test (use before pushing)"
+
+# Go targets
+go-test:
+	@echo "Running Go tests..."
+	cd src/Backend/opti-sql-go && go test -v ./...
+
+go-test-race:
+	@echo "Running Go tests with race detector..."
+	cd src/Backend/opti-sql-go && go test -race -v ./...
+
+go-test-coverage:
+	@echo "Running Go tests with coverage..."
+	cd src/Backend/opti-sql-go && go test -v -coverprofile=coverage.out ./...
+	cd src/Backend/opti-sql-go && go tool cover -func=coverage.out
+
+go-run:
+	@echo "Running Go application..."
+	cd src/Backend/opti-sql-go && go run main.go
+
+go-build:
+	@echo "Building Go application..."
+	cd src/Backend/opti-sql-go && go build -o opti-sql-go
+
+go-lint:
+	@echo "Running Go linter..."
+	cd src/Backend/opti-sql-go && golangci-lint run ./...
+
+go-fmt:
+	@echo "Formatting Go code..."
+	cd src/Backend/opti-sql-go && go fmt ./...
+
+# Rust targets
+rust-test:
+	@echo "Running Rust tests..."
+	cd src/Backend/opti-sql-rs && cargo test --verbose
+
+rust-run:
+	@echo "Running Rust application..."
+	cd src/Backend/opti-sql-rs && cargo run
+
+rust-build:
+	@echo "Building Rust application..."
+	cd src/Backend/opti-sql-rs && cargo build --release
+
+rust-lint:
+	@echo "Running Rust linter..."
+	cd src/Backend/opti-sql-rs && cargo clippy --all-targets --all-features -- -D warnings
+
+rust-fmt:
+	@echo "Formatting Rust code..."
+	cd src/Backend/opti-sql-rs && cargo fmt
+
+rust-fmt-check:
+	@echo "Checking Rust formatting..."
+	cd src/Backend/opti-sql-rs && cargo fmt --check
+
+# Combined targets
+test-all: go-test rust-test
+	@echo "All tests completed!"
+
+lint-all: go-lint rust-lint
+	@echo "All linting completed!"
+
+fmt-all: go-fmt rust-fmt
+	@echo "All formatting completed!"
+
+# Pre-push verification
+pre-push: fmt-all lint-all test-all
+	@echo "All checks passed! Ready to push."
+
+# Clean targets
+clean-go:
+	@echo "Cleaning Go build artifacts..."
+	cd src/Backend/opti-sql-go && go clean
+	rm -f src/Backend/opti-sql-go/opti-sql-go
+	rm -f src/Backend/opti-sql-go/coverage.out
+
+clean-rust:
+	@echo "Cleaning Rust build artifacts..."
+	cd src/Backend/opti-sql-rs && cargo clean
+
+clean-all: clean-go clean-rust
+	@echo "All build artifacts cleaned!"
diff --git a/README.md b/README.md
index 8132784..4702126 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,135 @@
-custom in memory query execution enginee
+# OptiSQL
+
+A high-performance, in-memory query execution engine.
+
+![Go Tests](https://github.com/Rich-T-kid/OptiSQL/actions/workflows/go-test.yml/badge.svg)
+![Rust Tests](https://github.com/Rich-T-kid/OptiSQL/actions/workflows/rust-test.yml/badge.svg)
+
+## Overview
+
+OptiSQL is a custom in-memory query execution engine. The backend (physical execution) is built using golang and rust.The front end (query parsing & optimization) is built using C++.
+
+**Technologies:**
+- Go/Rust (physical optimizer, operators)
+- Substrait (logical/physical plan representation)
+- C++ (query parser & optimizer)
+- ect (make,git,s3)
+## Getting Started
+
+### Prerequisites
+- Go 1.24+
+- Rust 1.70+
+- C++ (marco update this)
+- Make
+- git
+
+### Quick Start
+
+```bash
+# Clone the repository
+git clone https://github.com/Rich-T-kid/OptiSQL.git
+cd OptiSQL
+
+# Build and run Go backend
+make go-run
+
+# Build and run Rust backend
+make rust-run
+
+# Run all tests
+make test-all
+
+# Verify everything (format, lint, test)
+make pre-push
+```
+
+See `make help` for all available commands.
+
+## Project Structure
+
+```
+OptiSQL/
+├── src/
+│   ├── Backend/
+│   │   ├── opti-sql-go/          # Go implementation (primary)
+│   │   │   ├── operators/        # Query operators (filter, join, aggr, etc.)
+│   │   │   ├── phy-optimizer/    # Query optimization logic
+│   │   │   └── substrait/        # Substrait integration
+│   │   └── opti-sql-rs/          # Rust implementation (Go clone for learning)
+│   │       ├── src/project/      # Core project logic
+│   │       └── src/              # Query processing modules
+│   └── FrontEnd/                 # C++ frontend (in development)
+├── .github/workflows/            # CI/CD pipelines
+├── Makefile                      # Development commands
+└── CONTRIBUTING.md               # Contribution guidelines
+```
+
+**Development Approach:**
+
+Initial development is done in **Go** (`opti-sql-go`), which serves as the primary implementation. The **Rust** version (`opti-sql-rs`) is developed shortly after as a learning exercise and eventual performance-optimized alternative, closely mirroring the Go implementation.
+
+**Key Directories:**
+- `/operators` - SQL operator implementations (filter, join, aggregation, project)
+- `/physical-optimizer` - Query plan parsing and optimization
+- `/substrait` - Substrait plan integration
+- `/project` - [Add description]
+
+## Branching Model
+
+We use a structured branching model to maintain stability and enable smooth collaboration:
+
+- **`main`** - Production-ready code. Always stable and deployable. Represents released versions.
+- **`pre-release`** - Accumulation branch for completed features awaiting release. Multiple features are merged here, tested together, and pushed to `main` as a single versioned release.
+- **`feature/*`** - Individual feature development (e.g., `feature/hash-join`).
+- **`fix/*`** - Bug fixes (e.g., `fix/null-handling`).
+
+**Why This Model?**
+
+This approach prevents unstable code from reaching `main`, simplifies rollbacks, and ensures all changes undergo proper testing and review before deployment. Feature branches isolate work, allowing focused reviews and parallel development without conflicts. The `pre-release` branch acts as a staging area where features are bundled together before being released as a new version.
+
+**Workflow:**
+1. Create a feature branch from `pre-release`
+2. Implement your changes with tests
+3. Open a PR to merge into `pre-release`
+4. Once enough features accumulate (e.g., projectExec + filter), `pre-release` is merged into `main` as a new version
+
+## Development
+
+### Code Quality
+
+All code quality checks are automated and enforced by CI:
+- **Linting** - `golangci-lint` (Go), `clippy` (Rust)
+- **Formatting** - `go fmt` (Go), `cargo fmt` (Rust)
+- **Testing** - Unit tests required for all new code
+
+**Style and linting rules are non-negotiable and handled by automated linters.** This ensures consistency across the codebase and reduces bikeshedding during code reviews.
+
+### Pull Requests
+
+- Keep PRs small and focused on a single logical change
+- Include tests for new functionality
+- Ensure all CI checks pass before requesting review
+- Follow commit message conventions (see CONTRIBUTING.md)
+
+### Running Checks Locally
+
+Before pushing, verify your changes pass all checks:
+
+```bash
+make pre-push
+```
+
+This runs formatting, linting, and all tests.
+
+## Contributing
+
+Want to contribute? Check out [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines on:
+- Writing and running tests
+- PR format and commit message conventions
+- Development workflow and tooling
+- Build and run instructions
+
+## License
+
+This project is licensed under the terms specified in [LICENSE.txt](LICENSE.txt).
 
-![Tests](https://github.com/Rich-T-kid/OptiSQL/actions/workflows/go-test.yml/badge.svg)
\ No newline at end of file
diff --git a/src/Backend/opti-sql-go/go.mod b/src/Backend/opti-sql-go/go.mod
index 3520aab..afe0dde 100644
--- a/src/Backend/opti-sql-go/go.mod
+++ b/src/Backend/opti-sql-go/go.mod
@@ -1,3 +1,3 @@
 module opti-sql-go
 
-go 1.25.0
+go 1.24.0
diff --git a/src/Backend/opti-sql-go/physical-optimizer/optimize.go b/src/Backend/opti-sql-go/physical-optimizer/optimize.go
index ec74b68..5d6461f 100644
--- a/src/Backend/opti-sql-go/physical-optimizer/optimize.go
+++ b/src/Backend/opti-sql-go/physical-optimizer/optimize.go
@@ -1 +1,3 @@
 package physicaloptimizer
+
+// optimize the parsed plan
diff --git a/src/Backend/opti-sql-rs/src/main.rs b/src/Backend/opti-sql-rs/src/main.rs
index a582aa8..31841df 100644
--- a/src/Backend/opti-sql-rs/src/main.rs
+++ b/src/Backend/opti-sql-rs/src/main.rs
@@ -1,8 +1,8 @@
-use datafusion::arrow::record_batch::RecordBatch;
+//use datafusion::arrow::record_batch::RecordBatch;
 mod project;
-fn main(){
+#[allow(dead_code)]
+fn main() {
     println!("Hello, world!");
     project::project_exec::project_execute();
     project::source::csv::read_csv();
-    
-}
\ No newline at end of file
+}
diff --git a/src/Backend/opti-sql-rs/src/project/mod.rs b/src/Backend/opti-sql-rs/src/project/mod.rs
index 337083b..33352d1 100644
--- a/src/Backend/opti-sql-rs/src/project/mod.rs
+++ b/src/Backend/opti-sql-rs/src/project/mod.rs
@@ -1,2 +1,2 @@
-pub mod source;        // folder = "source"
-pub mod project_exec;  // file = "project_exec.rs"
+pub mod project_exec;
+pub mod source;
diff --git a/src/Backend/opti-sql-rs/src/project/source/csv.rs b/src/Backend/opti-sql-rs/src/project/source/csv.rs
index 5e80396..021581e 100644
--- a/src/Backend/opti-sql-rs/src/project/source/csv.rs
+++ b/src/Backend/opti-sql-rs/src/project/source/csv.rs
@@ -1,4 +1,3 @@
-
 pub fn read_csv() {
     println!("Reading CSV...");
 }
diff --git a/src/Backend/opti-sql-rs/src/project/source/json.rs b/src/Backend/opti-sql-rs/src/project/source/json.rs
index e69de29..8b13789 100644
--- a/src/Backend/opti-sql-rs/src/project/source/json.rs
+++ b/src/Backend/opti-sql-rs/src/project/source/json.rs
@@ -0,0 +1 @@
+
diff --git a/src/Backend/opti-sql-rs/src/project/source/mod.rs b/src/Backend/opti-sql-rs/src/project/source/mod.rs
index 8665f44..d913a84 100644
--- a/src/Backend/opti-sql-rs/src/project/source/mod.rs
+++ b/src/Backend/opti-sql-rs/src/project/source/mod.rs
@@ -1,3 +1,3 @@
 pub mod csv;
 pub mod json;
-pub mod parquet;
\ No newline at end of file
+pub mod parquet;
diff --git a/src/Backend/opti-sql-rs/src/project/source/parquet.rs b/src/Backend/opti-sql-rs/src/project/source/parquet.rs
index 8187697..488df1f 100644
--- a/src/Backend/opti-sql-rs/src/project/source/parquet.rs
+++ b/src/Backend/opti-sql-rs/src/project/source/parquet.rs
@@ -1,3 +1,4 @@
+#[allow(dead_code)]
 pub fn read_parquet() {
-    println!("Reading CSV...");
+    println!("Reading Parquet...");
 }