Contributing

Hearthwork is open source under the MIT license: github.com/BillyMRX1/hearthwork.

Get the code

git clone https://github.com/BillyMRX1/hearthwork
cd hearthwork

The package has no runtime dependencies. The code is in src/hearthwork/, the tests in tests/, and this website in docs-site/.

Run your working copy without installing it by setting PYTHONPATH=src:

PYTHONPATH=src python -m hearthwork --version

On Windows PowerShell, set $env:PYTHONPATH = "src" first.

Pages

• Tests
• Adding an agent
• Release (maintainers)
• This website

Open an issue before starting a large change, so the idea can be discussed first.