3.5 KiB
Contributing
Introduction
We appreciate your interest in considering contributing to go-redis. Community contributions mean a lot to us.
Contributions we need
You may already know how you'd like to contribute, whether it's a fix for a bug you encountered, or a new feature your team wants to use.
If you don't know where to start, consider improving documentation, bug triaging, and writing tutorials are all examples of helpful contributions that mean less work for you.
Your First Contribution
Unsure where to begin contributing? You can start by looking through help-wanted issues.
Never contributed to open source before? Here are a couple of friendly tutorials:
Getting Started
Here's how to get started with your code contribution:
- Create your own fork of go-redis
- Do the changes in your fork
- If you need a development environment, run
make test. Note: this clones and builds the latest release of redis. You also need a redis-stack-server docker, in order to run the capabilities tests. This can be started by running:docker run -p 6379:6379 -it redis/redis-stack-server:edge - While developing, make sure the tests pass by running
make tests - If you like the change and think the project could use it, send a pull request
To see what else is part of the automation, run invoke -l
Testing
Call make test to run all tests, including linters.
Continuous Integration uses these same wrappers to run all of these tests against multiple versions of python. Feel free to test your changes against all the go versions supported, as declared by the build.yml file.
Troubleshooting
If you get any errors when running make test, make sure
that you are using supported versions of Docker and go.
How to Report a Bug
Security Vulnerabilities
NOTE: If you find a security vulnerability, do NOT open an issue. Email Redis Open Source (oss@redis.com) instead.
In order to determine whether you are dealing with a security issue, ask yourself these two questions:
- Can I access something that's not mine, or something I shouldn't have access to?
- Can I disable something for other people?
If the answer to either of those two questions are yes, then you're probably dealing with a security issue. Note that even if you answer no to both questions, you may still be dealing with a security issue, so if you're unsure, just email us.
Everything Else
When filing an issue, make sure to answer these five questions:
- What version of go-redis are you using?
- What version of redis are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
Suggest a feature or enhancement
If you'd like to contribute a new feature, make sure you check our issue list to see if someone has already proposed it. Work may already be underway on the feature you want or we may have rejected a feature like it already.
If you don't see anything, open a new issue that describes the feature you would like and how it should work.
Code review process
The core team regularly looks at pull requests. We will provide feedback as soon as possible. After receiving our feedback, please respond within two weeks. After that time, we may close your PR if it isn't showing any activity.