Contributing

Contributing Policy

Contributing to Redisext should be done using pull request for https://github.com/mylokin/redisext. There are core maintainers that will approve pull requests. Code should be merged to master branch only by head maintainer and package owner.

Workflow:

  1. Fork https://github.com/mylokin/redisext
  2. Make your changes
  3. Make sure tests are passed succesfuly
  4. Pull Request

Test Suite

Redisext uses 100% tests coverage to provide better quality code. Thus tests running is essential. To run tests use:

make tests

but it requires Redis server. How to get working redis server on your machine read below.

Environment Setup

Redisext test suite requires installed Redis server. Tests are using Redis located on 6379 port on localhost and db 0 by default. But this could be re-configured using REDIS_HOST, REDIS_PORT and REDIS_DB environment variables.

Docker Image

Simpliest way to get Redis server instance localy is to use Docker image:

docker run --name redisext -p 6379:6379 -d redis

Note

This command is bound to make redis.

Docker

Check out official Docker documentation available here to get Docker.

OSX Redis Recipe

Redisext contains helpers to get your Redis server instance as fast as possible. Pre-requirements:

  • Parallels Desktop VM
  • Vagrant
  • Docker
  • Ansible

To get running redis instance you need to execute:

cd etc && make
export DOCKER_HOST="tcp://.."  # you'll see address after prev. command
make

Those commands will do this:

  1. Run Ubuntu 14.04 VM using Vagrant/Parallels
  2. Install Docker onto this VM
  3. Export Docker server port
  4. Run Redis image using Docker and expose 6379 port to localhost

Note

Redisext recipe is only initial setup procedure for Redis server. Don’t forget to shutdown your container and VM afterall. Also this approach requires basic knoledge about Vagrant and Docker (for example how to restart your container or VM).

License

Redisext is distributed under MIT license.