Skip to content

Commit

Permalink
Update contribution guideline (#2958)
Browse files Browse the repository at this point in the history
* Update contribution guideline

* Focus contribution guideline

* Address reviews

* Address review

* Address reviews
  • Loading branch information
sazzad16 authored Mar 29, 2022
1 parent 027f79a commit 83af8c1
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 38 deletions.
52 changes: 23 additions & 29 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,35 @@
# 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 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).

Jedis Google Group address:

https://groups.google.com/forum/?fromgroups#!forum/jedis_redis
Please post general questions to Google Groups or Github discussions. These can be closed without response when posted to Github issues.

Please post General questions to Google Group. It can be closed without answer when posted to Github issue.
# How to contribute by Pull Request

1. Fork Jedis repo on github ([how to fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo))
2. Create a topic branch (`git checkout -b my_branch`)
3. Push to your remote branch (`git push origin my_branch`)
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))

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 Test Environment

Jedis unit tests run with the latest [Redis unstable branch](https://github.com/redis/redis/tree/unstable).
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```.

# Some rules of Jedis source code

## Code Convention

* Jedis uses ```HBase Formatter``` introduced by [HBASE-5961](https://issues.apache.org/jira/browse/HBASE-5961)
* Jedis uses HBase Formatter introduced by [HBASE-5961](https://issues.apache.org/jira/browse/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 run ```make format``` anytime to reformat without IDEs
Expand All @@ -30,27 +47,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!
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@

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

## Contributing

We'd love your contributions!

**Bug reports** are always welcome! [You can open a bug report on GitHub](https://github.com/redis/jedis/issues/new).

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.

## Getting started

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

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).

## Contributing

We'd love your contributions!

**Bug reports** are always welcome! [You can open a bug report on GitHub](https://github.com/redis/jedis/issues/new).

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.

## License

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


## Sponsorship

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

0 comments on commit 83af8c1

Please sign in to comment.