Merge pull request #1 from ch4r10t33r/feature

feat: initial implementation of XMSS hash-sig in pure zig

Author: ch4r10t33r

.github/workflows/README.md

@@ -0,0 +1,93 @@
+# GitHub Actions Workflows
+
+## CI Workflow
+
+The `ci.yml` workflow runs on every push or pull request to `main`, `master`, or `develop` branches.
+
+### Jobs
+
+#### 1. Lint
+- **Runs on:** Ubuntu Latest
+- **Zig Version:** 0.14.1
+- **Steps:**
+  - Checkout code
+  - Setup Zig
+  - Run `zig build lint` (using zlinter)
+
+#### 2. Test
+- **Runs on:** Ubuntu, macOS, Windows
+- **Zig Version:** 0.14.1
+- **Matrix Strategy:** Tests on 3 platforms
+- **Steps:**
+  - Checkout code
+  - Setup Zig
+  - Run `zig build test`
+  - Build library with `zig build`
+
+#### 3. Build Examples
+- **Runs on:** Ubuntu Latest
+- **Zig Version:** 0.14.1
+- **Dependencies:** Runs after lint and test jobs succeed
+- **Steps:**
+  - Build library
+  - Run example application
+
+### Trigger Events
+
+The workflow triggers on:
+- **Push** to main, master, or develop branches
+- **Pull requests** targeting main, master, or develop branches
+
+### Badge
+
+The CI status badge in README.md:
+
+```markdown
+[![CI](https://github.com/ch4r10t33r/hash-zig/actions/workflows/ci.yml/badge.svg)](https://github.com/ch4r10t33r/hash-zig/actions/workflows/ci.yml)
+```
+
+### Local Testing
+
+Before pushing, you can run the same checks locally with Zig 0.14.1:
+
+```bash
+# Run linting
+zig build lint
+
+# Run tests
+zig build test
+
+# Build library
+zig build
+
+# Run example
+zig build example
+```
+
+### Supported Zig Version
+
+- **0.14.1** - Required version (zlinter only supports 0.14.x)
+
+**Note:** The project uses zlinter which currently only supports Zig 0.14.x. Once zlinter adds support for Zig 0.15+, the CI will be updated.
+
+### Platform Support
+
+- **Linux** (Ubuntu Latest)
+- **macOS** (macOS Latest)
+- **Windows** (Windows Latest)
+
+All tests must pass on all platforms before merging to protected branches.
+
+### Linter (zlinter)
+
+The project uses [zlinter](https://github.com/kurtwagner/zlinter) - an extendable Zig linter integrated into the build system.
+
+**Enabled rules:**
+- `field_naming` - Enforce field naming conventions
+- `declaration_naming` - Enforce declaration naming conventions (snake_case)
+- `function_naming` - Enforce function naming conventions
+- `no_unused` - Detect unused declarations
+- `no_deprecated` - Warn about deprecated API usage
+
+**Customization:**
+See `build.zig` to add/remove rules or adjust severity levels.

.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+      - develop
+  pull_request:
+    branches:
+      - main
+      - master
+      - develop
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: 0.14.1
+      
+      - name: Verify Zig installation
+        run: zig version
+      
+      - name: Run lint
+        run: zig build lint
+  
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: 0.14.1
+      
+      - name: Verify Zig installation
+        run: zig version
+      
+      - name: Run tests
+        run: zig build test
+      
+      - name: Build library
+        run: zig build
+  
+  build-examples:
+    name: Build Examples
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: 0.14.1
+      
+      - name: Build library
+        run: zig build-lib src/root.zig --name hash_zig

.gitignore

@@ -0,0 +1,59 @@
+# Zig build artifacts
+zig-cache/
+zig-out/
+.zig-cache/
+
+# Build outputs
+*.o
+*.so
+*.a
+*.dylib
+*.dll
+*.lib
+*.exe
+
+# Editor and IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Test artifacts
+test_*
+*.test
+
+# Temporary files
+tmp/
+temp/
+*.tmp
+
+# Logs
+*.log
+
+# Documentation build artifacts
+docs/
+site/
+
+# OS-specific files
+Thumbs.db
+desktop.ini
+
+# Backup files
+*.bak
+*.backup
+
+# Lock files (keep .lock files for reproducible builds)
+# Uncomment if you want to ignore lock files:
+# *.lock
+
+# Local configuration
+config.local.*
+.env
+.env.local
+
+# Coverage reports
+coverage/
+*.profdata
+*.profraw