Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contribution guideline #2958

Merged
merged 5 commits into from
Mar 29, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update contribution guideline
  • Loading branch information
sazzad16 committed Mar 27, 2022
commit 561ccdf68e2035e5be7224c6b70cbcbad195132a
52 changes: 24 additions & 28 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
# How to use Jedis Github Issue

* Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature requests. Everything else belongs to the Jedis Google Group.
* Github issues SHOULD ONLY BE USED to report bugs and for DETAILED feature requests. Everything else belongs to the [Jedis Google Group](https://groups.google.com/g/jedis_redis) or [Jedis GitHub Discussions](https://github.com/redis/jedis/discussions).
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved

Jedis Google Group address:

https://groups.google.com/forum/?fromgroups#!forum/jedis_redis
Please post General questions to Google Group or Github discussions. It can be closed without answer when posted to Github issues.
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved

Please post General questions to Google Group. It can be closed without answer when posted to Github issue.
# How to contribute by Pull Request
chayim marked this conversation as resolved.
Show resolved Hide resolved

1. Fork Jedis on github (https://help.github.com/articles/fork-a-repo/)
chayim marked this conversation as resolved.
Show resolved Hide resolved
2. Create a topic branch (git checkout -b my_branch)
3. Push to your branch (git push origin my_branch)
4. Post a pull request on github (https://help.github.com/articles/creating-a-pull-request/)
chayim marked this conversation as resolved.
Show resolved Hide resolved

It is recommended to create branch with meaningful name, not modifying master branch directly.
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved

Please add unit tests in order to prove your modification works smoothly. And please make sure your modification passes all unit tests.
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved

# Jedis Test Environment

Jedis unit tests run with latest [Redis unstable branch](https://github.com/redis/redis/tree/unstable).
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved
Please let them prepared and installed.

Jedis unit tests use many Redis instances, so we use ```Makefile``` to prepare environment.
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved

You can start test with ```make test```.
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved
You can set up test environments by ```make start```, and tear down environments by ```make stop```.
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved

If one or some of unit tests in current master branch of Jedis fails with Redis unstable branch, please post it to Github issue, and go ahead with other unit tests at your work.
sazzad16 marked this conversation as resolved.
Show resolved Hide resolved

# Some rules of Jedis source code

Expand All @@ -30,27 +49,4 @@ Please post General questions to Google Group. It can be closed without answer w
* Caution: use String.toBytes() directly will break GBK support!
* boolean, int, long, double -> byte array : use Protocol.toByteArray()

# How to contribute by Pull Request

1. Fork Jedis on github (https://help.github.com/articles/fork-a-repo/)
2. Create a topic branch (git checkout -b my_branch)
3. Push to your branch (git push origin my_branch)
4. Post a pull request on github (https://help.github.com/articles/creating-a-pull-request/)

I recommend you to create branch with meaningful name, not modifying master branch directly.

Please add unit tests in order to prove your modification works smoothly. And please make sure your modification passes all unit tests.

# Jedis Test Environment

Jedis unit tests run with latest [```Redis unstable branch```](https://github.com/antirez/redis).
Please let them prepared and installed.

Jedis unit tests use many Redis instances, so we use ```Makefile``` to prepare environment.

You can start test with ```make test```.
You can set up test environments by ```make start```, and tear down environments by ```make stop```.

If one or some of unit tests in current master branch of Jedis fails with Redis unstable branch, please post it to Github issue, and go ahead with other unit tests at your work.

Thanks!