- Github issues SHOULD BE USED to report bugs and for DETAILED feature requests. Everything else belongs in the Jedis Google Group or Jedis Github Discussions.
Please post general questions to Google Groups or Github discussions. These can be closed without response when posted to Github issues.
- Fork Jedis repo on github (how to fork a repo)
- Create a topic branch (
git checkout -b my_branch) - Push to your remote branch (
git push origin my_branch) - Create a pull request on github (how to create a pull request)
Create a branch with meaningful name, and do not modify the master branch directly.
Please add unit tests to validate your changes work, then ensure your changes pass all unit tests.
Jedis unit tests run with the latest Redis unstable branch. Please let them prepared and installed.
Jedis unit tests use many Redis instances, so we use a Makefile to prepare environment.
Start unit tests with make test.
Set up test environments with make start, tear down those environments with make stop and clean up the environment files with make cleanup.
- Jedis uses HBase Formatter introduced by HBASE-5961
- You can import code style file (located to hbase-formatter.xml) to Eclipse, IntelliJ
- line break by column count seems not working with IntelliJ
You can runmake formatanytime to reformat without IDEs- DO NOT format the source codes within
io.redis.examplestest package. - A test class name MUST NOT end with
Example.
- Jedis uses many interfaces to structure commands
- planned to write documentation about it, contribution is more welcome!
- We need to add commands to all interfaces which have responsibility to expose
- ex) We need to add ping() command to BasicCommands, and provide implementation to all of classes which implemented BasicCommands
- string <-> byte array : use SafeEncoder.encode()
- Caution: use String.toBytes() directly will break GBK support!
- boolean, int, long, double -> byte array : use Protocol.toByteArray()
Thanks!