File tree Expand file tree Collapse file tree 2 files changed +37
-0
lines changed Expand file tree Collapse file tree 2 files changed +37
-0
lines changed Original file line number Diff line number Diff line change
1
+ ## Legal
2
+
3
+ By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch
4
+ that your contributions are licensed under the [ Apache 2.0 license] ( https://www.apache.org/licenses/LICENSE-2.0.html ) (see [ ` LICENSE ` ] ( ../LICENSE ) ).
5
+
6
+ ## Submitting a Bug
7
+
8
+ Please ensure to specify the following:
9
+
10
+ * NIORedis commit hash
11
+ * Simplest possible steps to reproduce
12
+ * A pull request with a failing test case is preferred, but it's just as fine to write it in the issue description
13
+ * Environment Information
14
+ * For example, are you running in Docker? How are you connecting to it through Docker? What version of Docker?
15
+ * OS version and output of ` uname -a `
16
+ * Swift version or output of ` swift --version `
17
+
18
+ ## Submitting a Pull Request
19
+
20
+ A great PR that is likely to be merged quickly is:
21
+
22
+ 1 . Concise, with as few changes as needed to achieve the end result.
23
+ 1 . Tested, ensuring that regressions aren't introduced now or in the future.
24
+ 1 . Documented, adding API documentation as needed to cover new functions and properties.
25
+ 1 . Accompanied by a [ great commit message] ( https://chris.beams.io/posts/git-commit/ )
Original file line number Diff line number Diff line change @@ -41,3 +41,15 @@ let result = try connection.set("my_key", to: "some value")
41
41
42
42
print (result) // Optional("some value")
43
43
```
44
+
45
+ ## Contributing
46
+
47
+ Check out [CONTRIBUTING.md ](CONTRIBUTING.md ) for more information on how to help with NIORedis.
48
+
49
+ It is highly recommended to use [Docker](https :// docker.com) to install Redis locally.
50
+
51
+ ```bash
52
+ docker run - d - p 6379 : 6379 -- name nioredis redis: 5
53
+ ```
54
+
55
+ Otherwise, install Redis directly on your machine from [Redis.io ](https :// redis.io/download).
You can’t perform that action at this time.
0 commit comments