Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (44 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 2.07 KB

Contributing to AGS Scraper

Prerequisites

  • Rust (stable toolchain) — install via rustup.rs
  • Node.js — required for the Tauri CLI (cargo tauri)
  • WebView2 Runtime — pre-installed on Windows 11; download from Microsoft if needed

ScreenScraper Developer Credentials

The ScreenScraper integration requires a developer API account, separate from a regular user account. Reach out to the maintainer if you have any questions.

Steps:

  1. Create a regular ScreenScraper account at screenscraper.fr
  2. Request developer API access via the ScreenScraper developer forum
  3. Once approved, create the file src-tauri/.cargo/config.toml with your credentials:
# Local developer credentials for ScreenScraper API.
# Never commit this file.
[env]
SCREENSCRAPER_DEV_ID = "your-dev-id-here"
SCREENSCRAPER_DEV_PASSWORD = "your-dev-password-here"
  1. This file is listed in .gitignore — never commit it
  2. Without these env vars, cargo check will fail with a compile error (intentional — prevents accidental builds without credentials)

Build Commands

Run from the project root (ags-scraper/):

# Development mode (hot-reload frontend)
cargo tauri dev

# Production build — produces a portable .exe
cargo tauri build

Raw Rust commands run from src-tauri/:

cd src-tauri

# Type-check without building
cargo check

# Run unit tests
cargo test

Code Style

Rust: Format with cargo fmt before committing. Run cargo clippy and resolve any warnings.

TypeScript / CSS: No formatter is enforced — follow the conventions in the existing files (2-space indent, single quotes in JS, no trailing commas in HTML attributes).

Pull Request Process

  1. Fork the repository and create a branch from main
  2. Make your changes and test them in dev mode (cargo tauri dev)
  3. Ensure cargo check, cargo test, and cargo clippy all pass (from src-tauri/)
  4. Open a PR against main, linking any related issues