chore: update CONTRIBUTING.md and add Makefile for development workflow

* Add Docker-based development commands to CONTRIBUTING.md
* Create Makefile with development, testing, and Docker-related targets
* Include support for customizable Ruby version and Stream Chat URL
* Add convenience commands for linting, testing, and type checking

Author: nijeesh-stream

CONTRIBUTING.md

@@ -1,4 +1,3 @@
-
 # :recycle: Contributing
 
 We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.
@@ -63,6 +62,34 @@ Recommended settings:
 }
 ```
 
+For Docker-based development, you can use:
+
+```shell
+$ make lint_with_docker      # Run linters in Docker
+$ make lint-fix_with_docker  # Fix linting issues in Docker
+$ make test_with_docker      # Run tests in Docker
+$ make check_with_docker     # Run both linters and tests in Docker
+$ make sorbet_with_docker    # Run Sorbet type checker in Docker
+```
+
+You can customize the Ruby version used in Docker by setting the RUBY_VERSION variable:
+
+```shell
+$ RUBY_VERSION=3.1 make test_with_docker
+```
+
+By default, the API client connects to the production Stream Chat API. You can override this by setting the STREAM_CHAT_URL environment variable:
+
+```shell
+$ STREAM_CHAT_URL=http://localhost:3030 make test
+```
+
+When running tests in Docker, the `test_with_docker` command automatically sets up networking to allow the Docker container to access services running on your host machine via `host.docker.internal`. This is particularly useful for connecting to a local Stream Chat server:
+
+```shell
+$ STREAM_CHAT_URL=http://host.docker.internal:3030 make test_with_docker
+```
+
 ### Commit message convention
 
 This repository follows a commit message convention in order to automatically generate the [CHANGELOG](./CHANGELOG.md). Make sure you follow the rules of [conventional commits](https://www.conventionalcommits.org/) when opening a pull request.

Makefile

@@ -0,0 +1,50 @@
+STREAM_KEY ?= NOT_EXIST
+STREAM_SECRET ?= NOT_EXIST
+RUBY_VERSION ?= 3.0
+STREAM_CHAT_URL ?= https://chat.stream-io-api.com
+
+# These targets are not files
+.PHONY: help check test lint lint-fix test_with_docker lint_with_docker lint-fix_with_docker
+
+help: ## Display this help message
+	@echo "Please use \`make <target>\` where <target> is one of"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; \
+	{printf "\033[36m%-40s\033[0m %s\n", $$1, $$2}'
+
+lint: ## Run linters
+	bundle exec rubocop
+
+lint-fix: ## Fix linting issues
+	bundle exec rubocop -a
+
+test: ## Run tests
+	STREAM_KEY=$(STREAM_KEY) STREAM_SECRET=$(STREAM_SECRET) bundle exec rspec
+
+check: lint test ## Run linters + tests
+
+console: ## Start a console with the gem loaded
+	bundle exec rake console
+
+lint_with_docker: ## Run linters in Docker (set RUBY_VERSION to change Ruby version)
+	docker run -t -i -w /code -v $(PWD):/code ruby:$(RUBY_VERSION) sh -c "gem install bundler && bundle install && bundle exec rubocop"
+
+lint-fix_with_docker: ## Fix linting issues in Docker (set RUBY_VERSION to change Ruby version)
+	docker run -t -i -w /code -v $(PWD):/code ruby:$(RUBY_VERSION) sh -c "gem install bundler && bundle install && bundle exec rubocop -a"
+
+test_with_docker: ## Run tests in Docker (set RUBY_VERSION to change Ruby version)
+	docker run -t -i -w /code -v $(PWD):/code --add-host=host.docker.internal:host-gateway -e STREAM_KEY=$(STREAM_KEY) -e STREAM_SECRET=$(STREAM_SECRET) -e "STREAM_CHAT_URL=http://host.docker.internal:3030" ruby:$(RUBY_VERSION) sh -c "gem install bundler && bundle install && bundle exec rspec"
+
+check_with_docker: lint_with_docker test_with_docker ## Run linters + tests in Docker (set RUBY_VERSION to change Ruby version)
+
+sorbet: ## Run Sorbet type checker
+	bundle exec srb tc
+
+sorbet_with_docker: ## Run Sorbet type checker in Docker (set RUBY_VERSION to change Ruby version)
+	docker run -t -i -w /code -v $(PWD):/code ruby:$(RUBY_VERSION) sh -c "gem install bundler && bundle install && bundle exec srb tc"
+
+coverage: ## Generate test coverage report
+	COVERAGE=true bundle exec rspec
+	@echo "Coverage report available at ./coverage/index.html"
+
+reviewdog: ## Run reviewdog for CI
+	bundle exec rubocop --format json | reviewdog -f=rubocop -name=rubocop -reporter=github-pr-review