mirror of
https://github.com/swift-server/RediStack.git
synced 2026-06-02 07:37:33 +00:00
Nathan Harris
e81f9546d1
Motivation:
The SSWG has identified a fast approaching reality of namespace clashes in SPM within the ecosystem and has proposed a rule on names that `NIORedis` no longer complies with.
Modifications:
All references to `NIORedis` have been switched to `RedisNIO` as this module name is unique (at least within GitHub's public repositories).
The goals for this name are as follows:
1. To indicate that this is a Redis client library that is built with SwiftNIO
2. That it is a lower level library, as it directly exposes SwiftNIO as an implementation detail
2a. The idea being that a higher level library (`Redis`) will be used, and to "go one level deeper" in the stack, you append the "deeper" `NIO` postfix
3. It follows a naming pattern adopted by Vapor who has expressed their desire to adopt this library as their Redis implementation
Result:
A repository, package name, and module name that are unique across GitHub's public repositories that achives the goals outlined above.
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
## Legal
|
|
|
|
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
|
|
that your contributions are licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html) (see [`LICENSE`](../LICENSE)).
|
|
|
|
## Submitting a Bug
|
|
|
|
Please ensure to specify the following:
|
|
|
|
* RedisNIO commit hash
|
|
* Simplest possible steps to reproduce
|
|
* A pull request with a failing test case is preferred, but it's just as fine to write it in the issue description
|
|
* Environment Information
|
|
* For example, are you running in Docker? How are you connecting to it through Docker? What version of Docker?
|
|
* OS version and output of `uname -a`
|
|
* Swift version or output of `swift --version`
|
|
|
|
## Submitting a Pull Request
|
|
|
|
A great PR that is likely to be merged quickly is:
|
|
|
|
1. Concise, with as few changes as needed to achieve the end result.
|
|
1. Tested, ensuring that regressions aren't introduced now or in the future.
|
|
1. Documented, adding API documentation as needed to cover new functions and properties.
|
|
1. Accompanied by a [great commit message](https://chris.beams.io/posts/git-commit/)
|
|
|
|
# Contributor Conduct
|
|
|
|
All contributors are expected to adhere to this project's [Code of Conduct](CODE_OF_CONDUCT.md).
|