Contributing

Contributing

Thank you for your interest in contributing to RoK-Tracker! Whether you are reporting a bug, suggesting a feature, or writing code, your help is appreciated.

---

Reporting Bugs

If you found a bug, please open a bug report. A good bug report includes:

1. What happened — describe what went wrong.
2. Steps to reproduce — list the exact steps so the issue can be recreated.
3. Expected behavior — what should have happened instead.
4. Your setup — Windows version, Bluestacks version, and RoK-Tracker version.
5. Logs and screenshots — attach your sidecar.log file and any relevant screenshots.

---

Suggesting Features

Have an idea for a new feature? Open a feature request. Describe:

1. The problem — what limitation or frustration led to the idea.
2. Your proposed solution — what you would like the app to do.
3. Alternatives — any other approaches you have considered.

---

Contributing Code

Prerequisites

• Python 3.14+
• uv (Python package manager)
• Node.js 18+ with pnpm
• Rust (for the Tauri shell)
• Microsoft C++ Build Tools

Setting Up the Project

# 1. Fork and clone the repository
git clone https://github.com/<your-username>/RoK-Tracker.git
cd RokTracker

# 2. Install Python dependencies
uv sync

# 3. Install frontend dependencies
cd gui_frontend
pnpm install
cd ..

# 4. Place ADB and Tesseract data in deps/ (see Installation page)

# 5. Run the app in development mode
npx --prefix gui_frontend tauri dev

For a more detailed walkthrough, see the Building from Source page.

Submitting a Pull Request

1. Create a new branch from main for your changes.
2. Make your changes and test them locally.
3. Write a clear commit message describing what you changed and why.
4. Open a Pull Request against the main branch.
5. Describe your changes in the PR description and link any related issues.

---

Asking Questions

For general questions about how to use RoK-Tracker or how something works, please use GitHub Discussions instead of opening an issue. This keeps the issue tracker focused on bugs and feature requests.