Contributing Guide

Contributions to this project are welcome. If you have an idea for a bigger change, open an issue first and we can discuss it.

For fixes and small additions, follow the steps below to get developing and contributing:

Fork & clone the repository in GitHub
Run the bin/setup script to install development dependencies
Work on a branch
Make changes
Ensure tests and code style checks pass by running bin/rake (runs both StandardRB and tests)
Commit your changes, this project follows the Conventional Commits spec
Open up a pull request

Code Style

This project uses StandardRB for Ruby code style. StandardRB is an opinionated, zero-configuration linter and formatter.

Before committing your changes, make sure your code passes StandardRB:

bundle exec rake standard

To automatically fix most style issues:

bundle exec rake standard:fix

The default bin/rake command runs both StandardRB checks and the test suite, so you can verify everything at once.

Good First Issue — If you're new to the project or Ruby, check out the "good first issue" tag. They're smaller, approachable issues if you're just getting started.
Web — tasks that don't require much Ruby knowledge but require HTML and CSS have the "web" tag