Merge branch 'main' into release

Author: stringhandler

.github/workflows/github-pages.yml

@@ -0,0 +1,43 @@
+name: Deploy GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/github-pages.yml'
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -66,6 +66,23 @@ jobs:
         env:
           TAURI_SIGNING_PRIVATE_KEY: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY }}
 
+      - name: Extract changelog for this version
+        id: changelog
+        shell: bash
+        run: |
+          VERSION="${{ steps.version.outputs.VERSION }}"
+          # Extract the section for this version from CHANGELOG.md
+          # Finds content between ## [VERSION] and the next ## [
+          CHANGELOG=$(awk "/## \[${VERSION}\]/{flag=1; next} /## \[/{flag=0} flag" CHANGELOG.md)
+
+          # Output to GitHub Actions in multiline format
+          echo "CHANGELOG<<EOF" >> $GITHUB_OUTPUT
+          echo "$CHANGELOG" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+          echo "Extracted changelog:"
+          echo "$CHANGELOG"
+
       - uses: tauri-apps/tauri-action@v0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -75,7 +92,7 @@ jobs:
         with:
           tagName: v${{ steps.version.outputs.VERSION }}
           releaseName: 'Dota Keeper v${{ steps.version.outputs.VERSION }}'
-          releaseBody: 'See the assets below to download this release.'
+          releaseBody: ${{ steps.changelog.outputs.CHANGELOG }}
           releaseDraft: true
           prerelease: false
           args: ${{ matrix.args }}

CONTRIBUTING.md

@@ -0,0 +1,239 @@
+# Contributing to Dota Keeper
+
+Thank you for your interest in contributing to Dota Keeper! This document provides guidelines and instructions for contributing to the project.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Project Structure](#project-structure)
+- [Making Changes](#making-changes)
+- [Submitting Contributions](#submitting-contributions)
+- [Task Management](#task-management)
+- [Release Process](#release-process)
+- [Code Style](#code-style)
+- [Testing](#testing)
+
+## Getting Started
+
+Dota Keeper is a desktop application built with Tauri that tracks Dota 2 games and analyzes performance against personal goals.
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/) (v16 or higher)
+- [Rust](https://www.rust-lang.org/tools/install) (latest stable version)
+- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
+- Git
+
+## Development Setup
+
+1. **Fork and Clone**
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/dota-keeper.git
+   cd dota-keeper
+   ```
+
+2. **Install Dependencies**
+   ```bash
+   npm install
+   ```
+
+3. **Run Development Server**
+   ```bash
+   npm run tauri dev
+   ```
+
+4. **Build for Production**
+   ```bash
+   npm run tauri build
+   ```
+
+## Project Structure
+
+```
+dota-keeper/
+├── src/                    # Frontend source code
+├── src-tauri/              # Rust backend code
+├── docs/                   # GitHub Pages documentation
+├── meta/
+│   └── tasks/              # Task management
+│       ├── upnext/         # Tasks ready to be worked on
+│       ├── backlog/        # Future tasks
+│       ├── done/           # Completed tasks
+│       └── to_test/        # Tasks awaiting manual testing
+├── CLAUDE.md               # Project instructions and AI context
+├── CHANGELOG.md            # Version history
+└── package.json            # Project dependencies and scripts
+```
+
+### Key Directories
+
+- **`src/`**: Frontend code (HTML, CSS, JavaScript/TypeScript)
+- **`src-tauri/`**: Rust backend, API integrations, database logic
+- **`meta/tasks/`**: Project task management system
+- **`docs/`**: Project website and documentation
+
+## Making Changes
+
+### Before You Start
+
+1. **Check existing issues** to see if someone is already working on it
+2. **Create an issue** if you're planning a significant change
+3. **Create a new branch** from `main`:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+### Development Guidelines
+
+1. **Follow the project architecture**:
+   - Database storage in SQLite (located in `%LOCALAPPDATA%/DotaKeeper/`)
+   - API calls via OpenDota or Steam API
+   - Goal achievement should target ~75% success rate (see CLAUDE.md)
+
+2. **Write clear commit messages**:
+   ```
+   feat: add match history pagination
+   fix: correct KDA calculation
+   docs: update API integration guide
+   refactor: simplify goal evaluation logic
+   ```
+
+3. **Keep changes focused**: One feature or fix per pull request
+
+4. **Test your changes** thoroughly before submitting
+
+## Submitting Contributions
+
+### Pull Request Process
+
+1. **Update your branch** with the latest main:
+   ```bash
+   git fetch origin
+   git rebase origin/main
+   ```
+
+2. **Push your changes**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+3. **Create a Pull Request**:
+   - Use a clear, descriptive title
+   - Reference any related issues
+   - Describe what changed and why
+   - Include screenshots for UI changes
+   - List any breaking changes
+
+4. **Respond to feedback**: Address review comments promptly
+
+### Pull Request Template
+
+```markdown
+## Description
+Brief description of changes
+
+## Related Issues
+Fixes #123
+
+## Changes Made
+- Change 1
+- Change 2
+
+## Testing
+How was this tested?
+
+## Screenshots (if applicable)
+Add screenshots here
+```
+
+## Task Management
+
+The project uses a file-based task management system in `meta/tasks/`:
+
+- **Creating tasks**: Add `.md` files to `backlog/` or `upnext/`
+- **Working on tasks**: Move from `upnext/` to track active work
+- **Completing tasks**: Move to `to_test/` if manual verification needed, or `done/` if fully complete
+- **Testing documentation**: Include testing steps when moving to `to_test/`
+
+## Release Process
+
+### For Maintainers
+
+When creating a new release, update version numbers in:
+
+1. **`package.json`**: Update the `version` field
+2. **`src-tauri/Cargo.toml`**: Update the `version` field
+3. **`src-tauri/tauri.conf.json`**: Update the `version` field
+4. **`CHANGELOG.md`**: Document all changes in the new version
+
+Example workflow:
+```bash
+# Update versions in all three files
+# Update CHANGELOG.md with new version and changes
+git add package.json src-tauri/Cargo.toml src-tauri/tauri.conf.json CHANGELOG.md
+git commit -m "chore: bump version to 1.2.0"
+git tag v1.2.0
+git push origin main --tags
+```
+
+## Code Style
+
+### Frontend (JavaScript/TypeScript)
+- Use 2 spaces for indentation
+- Use semicolons
+- Prefer `const` over `let`, avoid `var`
+- Use meaningful variable names
+
+### Backend (Rust)
+- Follow [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
+- Run `cargo fmt` before committing
+- Run `cargo clippy` and address warnings
+- Write documentation comments for public APIs
+
+### General
+- Keep functions small and focused
+- Add comments for complex logic
+- Use descriptive names for variables and functions
+
+## Generating icons
+
+Run
+```
+cargo tauri icon .\assets\dotakeeper-icon-black.png
+```
+
+
+## Testing
+
+### Frontend Testing
+```bash
+npm test
+```
+
+### Rust Testing
+```bash
+cd src-tauri
+cargo test
+```
+
+### Manual Testing
+- Test on Windows (primary platform)
+- Verify database operations work correctly
+- Test API integrations with real Steam/OpenDota data
+- Verify UI changes across different screen sizes
+
+## Questions?
+
+If you have questions about contributing:
+- Check existing [Issues](https://github.com/YOUR_USERNAME/dota-keeper/issues)
+- Create a new issue with the `question` label
+- Reference the [CLAUDE.md](./CLAUDE.md) file for project context
+
+## License
+
+By contributing to Dota Keeper, you agree that your contributions will be licensed under the same license as the project.
+
+---
+
+Thank you for contributing to Dota Keeper! 🎮