Contributing

Thank you for your interest in contributing to warrior-bot!

Development Setup

Clone the repository:

git clone https://github.com/yourusername/warrior-bot.git
cd warrior-bot

Create a virtual environment:

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Install development dependencies:

pip install -r requirements-dev.txt
pip install -e .

Set up pre-commit hooks:

pre-commit install

Code Standards

We use several tools to maintain code quality:

black: Code formatting
isort: Import sorting
flake8: Linting
mypy: Type checking

Run all checks:

black warrior_bot/
isort warrior_bot/
flake8 warrior_bot/
mypy warrior_bot/

Or let pre-commit handle it automatically when you commit.

Adding a New Command

Create a new folder in warrior_bot/commands/:

mkdir warrior_bot/commands/mycommand

Create __init__.py with your command:

"""My command implementation."""

import click


@click.command()
def mycommand():
    """My command description."""
    click.echo("Hello from mycommand!")

Register it in warrior_bot/cli.py:

from warrior_bot.commands import mycommand

# In the cli function:
cli.add_command(mycommand.mycommand)

Documentation

Update the docs when adding features:

Edit files in the docs/ directory
Preview locally:

mkdocs serve

Visit http://127.0.0.1:8000 to see your changes

Submitting Changes

Create a new branch:

git checkout -b feature/my-feature

Make your changes and commit:

git add .
git commit -m "Add my feature"

Push and create a pull request:

git push origin feature/my-feature

Questions?

Feel free to open an issue if you have questions!