Merge pull request #3 from BruinGrowly/fix-harmonizer-bug-and-add-gitignore

feat: add production-level enhancements

Author: BruinGrowly

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 88

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+# .github/workflows/ci.yml
+
+name: Python Code Harmonizer CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -e .
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings
+          flake8 . --count --exit-zero --max-complexity=10 --statistics
+
+      - name: Check formatting with black
+        run: |
+          black --check .
+
+      - name: Test with pytest
+        run: |
+          pytest

CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to the Python Code Harmonizer
+
+First off, thank you for considering contributing! This project is a unique blend of philosophy and code, and your help is welcome in making it better.
+
+## Getting Started
+
+To get the project set up for local development, please follow these steps:
+
+1.  **Fork and Clone:**
+    *   Fork the repository on GitHub.
+    *   Clone your fork to your local machine:
+        ```sh
+        git clone https://github.com/YOUR_USERNAME/Python-Code-Harmonizer.git
+        cd Python-Code-Harmonizer
+        ```
+
+2.  **Set Up a Virtual Environment:**
+    *   It is highly recommended to use a virtual environment to keep dependencies isolated.
+        ```sh
+        python -m venv .venv
+        source .venv/bin/activate
+        ```
+
+3.  **Install Dependencies:**
+    *   The project and all its development dependencies can be installed with a single command. The `-e` flag installs the project in "editable" mode, which is essential for development.
+        ```sh
+        pip install -r requirements.txt
+        pip install -e .
+        ```
+
+## Running the Tools
+
+### Running the Harmonizer
+
+Once installed, you can run the harmonizer on any Python file using the `harmonizer` command-line script:
+
+```sh
+harmonizer examples/test_code.py
+```
+
+### Running the Test Suite
+
+This project uses `pytest` for testing. To run the full suite:
+
+```sh
+pytest
+```
+
+## Code Quality and Style
+
+We use `black` for code formatting and `flake8` for linting to ensure a consistent and high-quality codebase.
+
+### Formatting
+
+Before you commit your changes, please run `black` to automatically format your code:
+
+```sh
+black src/ tests/
+```
+
+### Linting
+
+You can check for any style issues or potential errors with `flake8`:
+
+```sh
+flake8 src/ tests/
+```
+
+Our Continuous Integration (CI) pipeline will automatically check for formatting and linting issues, so it's a good idea to run these tools locally before pushing your changes.
+
+## Submitting a Pull Request
+
+1.  Create a new branch for your feature or bug fix.
+2.  Make your changes, and be sure to add tests if you are adding new functionality.
+3.  Ensure your code is formatted with `black` and passes the `flake8` checks.
+4.  Make sure the full test suite passes with `pytest`.
+5.  Push your branch to your fork and open a pull request.
+
+Thank you for your contributions!