mirror of https://github.com/swift-server/RediStack.git synced 2026-05-03 07:32:28 +00:00

Files

T

Nathan Harris 04aa1f93a3 Polish project documents

Motivation:

To give a better first impression, and providing more comprehensive information for first time viewers, the README file needed reworking.

Modifications:

- Add a CHANGELOG file that at least redirects readers to the releases page of GitLab
- Update the CONTRIBUTORS list
- Change project README to have more information, flow better, and to have a better "first impression"

Result:

The README should give a stronger indication into the project's health.

2019-07-08 23:06:57 -07:00

1.7 KiB

Raw Permalink Blame History

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 (see LICENSE).

Submitting a Bug

Please ensure to specify the following:

RediStack 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

Development

Git Workflow

master is always the development branch.

For minor or patch SemVer changes, create a branch off of the tagged commit.

Environment Setup

It is highly recommended to use Docker to install Redis locally.

docker run -d -p 6379:6379 --name redis redis:5

Otherwise, install Redis directly on your machine from Redis.io.

Submitting a Pull Request

A great PR that is likely to be merged quickly is:

Concise, with as few changes as needed to achieve the end result.
Tested, ensuring that regressions aren't introduced now or in the future.
Documented, adding API documentation as needed to cover new functions and properties.
Accompanied by a great commit message

Contributor Conduct

All contributors are expected to adhere to this project's Code of Conduct.

1.7 KiB Raw Permalink Blame History