How to contribute

Thank you for your interest in contributing to RPyG! ❤️
Everyone is welcome — whether you're a beginner or an experienced developer.

This guide explains how to set up the project and contribute through Pull Requests.

---

1. Fork & Clone

git clone https://github.com/<your-username>/RPyG.git
cd RPyG

Create a local branch for your work:

git checkout -b feature/my-feature

---

2. Recommended Setup

Create and activate a virtual environment:

bash python -m venv .venv .venv\Scripts\activate # Windows source .venv/bin/activate # macOS/Linux /bash

Install dependencies:

pip install -r requirements.txt

---

3. Development Guidelines

• Write clean and readable code
• Keep functions focused on one task
• English only for code, comments & commits
• Prefer dataclasses for data structures
• Avoid introducing global states unless needed

---

4. Commit Message Convention

We use Conventional Commits format:

feat(scope): short explanation

Examples:

feat(hero): add gold currency
fix(ui): prevent double render
docs(readme): improve install guide

Valid types: feat · fix · docs · refactor · test · style · chore · perf

---

5. Pull Request Workflow

Push your branch:

bash git push origin feature/my-feature /bash

Then open a Pull Request to main ✔

PR Requirements:

• Clear description of changes
• Link to related Issue: Closes #
• Small and focused diff
• Review required

---

6. Issues to get started

Good First Issues list:
https://github.com/tryogaunt/RPyG/issues?q=is%3Aissue+label%3A%22good+first+issue%22

Feel free to ask for help or claim one!

---

7. Join the Community

Game design & discussions:
https://github.com/tryogaunt/RPyG/discussions

Your feedback shapes the adventure!

---

Contribution Checklist

• New branch created
• Code runs correctly
• Commit messages follow convention
• PR linked to Issue
• Reviewed & approved

---

Thank you for helping build RPyG! 🎲