Contributing to Mudis

Project Goals

Mudis is a lightweight, Ruby-native, in-memory cache intended for:

Mudis is not a distributed system, nor a replacement for Redis or Memcached.

Before submitting an issue or pull request, please read the following:

In-Scope ✅	Out-of-Scope ❌
In-process memory cache	Multi-node or clustered caches
Observability features	Built-in persistence or disk-based storage
Compression + serialization	Language-agnostic protocol support
Namespacing, TTL, limits	Background sync across nodes
Thread safety	Network daemons or long-running cache servers

If you're exploring a feature outside the scope, we recommend building on top of Mudis or forking to suit your architecture.

Fork the repo and create your feature branch:
git checkout -b my-feature
Write clear, test-covered code using RSpec and Rubocop standards
Document your changes, especially in:
- README.md for features
- CHANGELOG.md for version updates
Run the test suite

   bundle install
   bundle exec rspec

git clone https://github.com/your-name/mudis.git
cd mudis
bundle install
bundle exec rspec

To run the full test suite with coverage reporting:

rake coverage

This will:

The coverage report is saved to coverage/index.html and shows line-by-line test coverage.