Contributing to hanami-settings-stores #

Thank you for your interest in contributing to hanami-settings-stores. This guide will help you get started with development.

By submitting a contribution, you acknowledge that you have read and agree to our policies and that your contribution is licensed under the MIT License.

Ways to Contribute #

• Bug reports — Found a problem? Open an issue with steps to reproduce
• Code — Bug fixes, new stores, or improvements to existing ones
• Documentation — Typo fixes, better examples, or new guides
• Testing — Expand test coverage or improve existing specs
• Security vulnerabilities — Please report these privately per our security policy

Quick Start #

# Install mise (recommended)
curl https://mise.run | sh

# Install toolchain and run all checks
mise install
mise run lint

# Run tests
mise run spec

# Format and lint
mise run format
mise run lint

Without mise, run scripts directly from bin/:

./bin/spec
./bin/format/ruby
./bin/lint/ruby

Development Workflow #

1. Create a branch for your changes
2. Make your changes following the code style guide
3. Run mise run lint and mise run spec to verify everything passes
4. Submit a pull request

Common Tasks #

Task	Command	Description
Test	mise run spec	Run tests
Format	mise run format	Format all files
Lint	mise run lint	Lint all files
Build	mise run build	Build the gem

Guides #

Guide	Topics
Development Tasks	Available commands and toolchain
Code Style	Formatting, linting, code organization
Testing	Test structure and conventions