Skip to content

Commit 83af8c1

Browse files
authored
Update contribution guideline (#2958)
* Update contribution guideline * Focus contribution guideline * Address reviews * Address review * Address reviews
1 parent 027f79a commit 83af8c1

File tree

2 files changed

+31
-38
lines changed

2 files changed

+31
-38
lines changed

.github/CONTRIBUTING.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,35 @@
11
# How to use Jedis Github Issue
22

3-
* Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature requests. Everything else belongs to the Jedis Google Group.
3+
* Github issues SHOULD BE USED to report bugs and for DETAILED feature requests. Everything else belongs in the [Jedis Google Group](https://groups.google.com/g/jedis_redis) or [Jedis Github Discussions](https://github.com/redis/jedis/discussions).
44

5-
Jedis Google Group address:
6-
7-
https://groups.google.com/forum/?fromgroups#!forum/jedis_redis
5+
Please post general questions to Google Groups or Github discussions. These can be closed without response when posted to Github issues.
86

9-
Please post General questions to Google Group. It can be closed without answer when posted to Github issue.
7+
# How to contribute by Pull Request
8+
9+
1. Fork Jedis repo on github ([how to fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo))
10+
2. Create a topic branch (`git checkout -b my_branch`)
11+
3. Push to your remote branch (`git push origin my_branch`)
12+
4. Create a pull request on github ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request))
13+
14+
Create a branch with meaningful name, and do not modify the master branch directly.
15+
16+
Please add unit tests to validate your changes work, then ensure your changes pass all unit tests.
17+
18+
# Jedis Test Environment
19+
20+
Jedis unit tests run with the latest [Redis unstable branch](https://github.com/redis/redis/tree/unstable).
21+
Please let them prepared and installed.
22+
23+
Jedis unit tests use many Redis instances, so we use a ```Makefile``` to prepare environment.
24+
25+
Start unit tests with ```make test```.
26+
Set up test environments with ```make start```, tear down those environments with ```make stop``` and clean up the environment files with ```make cleanup```.
1027

1128
# Some rules of Jedis source code
1229

1330
## Code Convention
1431

15-
* Jedis uses ```HBase Formatter``` introduced by [HBASE-5961](https://issues.apache.org/jira/browse/HBASE-5961)
32+
* Jedis uses HBase Formatter introduced by [HBASE-5961](https://issues.apache.org/jira/browse/HBASE-5961)
1633
* You can import code style file (located to hbase-formatter.xml) to Eclipse, IntelliJ
1734
* line break by column count seems not working with IntelliJ
1835
* You can run ```make format``` anytime to reformat without IDEs
@@ -30,27 +47,4 @@ Please post General questions to Google Group. It can be closed without answer w
3047
* Caution: use String.toBytes() directly will break GBK support!
3148
* boolean, int, long, double -> byte array : use Protocol.toByteArray()
3249

33-
# How to contribute by Pull Request
34-
35-
1. Fork Jedis on github (https://help.github.com/articles/fork-a-repo/)
36-
2. Create a topic branch (git checkout -b my_branch)
37-
3. Push to your branch (git push origin my_branch)
38-
4. Post a pull request on github (https://help.github.com/articles/creating-a-pull-request/)
39-
40-
I recommend you to create branch with meaningful name, not modifying master branch directly.
41-
42-
Please add unit tests in order to prove your modification works smoothly. And please make sure your modification passes all unit tests.
43-
44-
# Jedis Test Environment
45-
46-
Jedis unit tests run with latest [```Redis unstable branch```](https://github.com/antirez/redis).
47-
Please let them prepared and installed.
48-
49-
Jedis unit tests use many Redis instances, so we use ```Makefile``` to prepare environment.
50-
51-
You can start test with ```make test```.
52-
You can set up test environments by ```make start```, and tear down environments by ```make stop```.
53-
54-
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.
55-
5650
Thanks!

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@
1313

1414
Jedis is a Java client for [Redis](https://github.com/redis/redis "Redis") designed for performance and ease of use.
1515

16+
## Contributing
17+
18+
We'd love your contributions!
19+
20+
**Bug reports** are always welcome! [You can open a bug report on GitHub](https://github.com/redis/jedis/issues/new).
21+
22+
You can also **contribute documentation** -- or anything to improve Jedis. Please see [contribution guideline](https://github.com/redis/jedis/blob/master/.github/CONTRIBUTING.md) for more details.
23+
1624
## Getting started
1725

1826
To get started with Jedis, first add it as a dependency in your Java project. If you're using Maven, that looks like this:
@@ -94,19 +102,10 @@ Hit us up on the [Redis Discord Server](http://discord.gg/redis) or [open an iss
94102

95103
You can also find help on the [Jedis mailing list](http://groups.google.com/group/jedis_redis) or the [GitHub Discussions](https://github.com/redis/jedis/discussions).
96104

97-
## Contributing
98-
99-
We'd love your contributions!
100-
101-
**Bug reports** are always welcome! [You can open a bug report on GitHub](https://github.com/redis/jedis/issues/new).
102-
103-
You can also **contribute documentation** -- or anything to improve Jedis. Please see [CONTRIBUTING.md](https://github.com/redis/jedis/blob/master/.github/CONTRIBUTING.md) for more details.
104-
105105
## License
106106

107107
Jedis is licensed under the [MIT license](https://github.com/redis/jedis/blob/master/LICENSE.txt).
108108

109-
110109
## Sponsorship
111110

112111
[![Redis Logo](redis-logo-full-color-rgb.png)](https://redis.com/)

0 commit comments

Comments
 (0)