|
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Introduction |
| 4 | + |
| 5 | +First off, thank you for considering contributions. We value community contributions! |
| 6 | + |
| 7 | +## Contributions We Need |
| 8 | + |
| 9 | +You may already know what you want to contribute \-- a fix for a bug you |
| 10 | +encountered, or a new feature your team wants to use. |
| 11 | + |
| 12 | +If you don't know what to contribute, keep an open mind! Improving |
| 13 | +documentation, bug triaging, and writing tutorials are all examples of |
| 14 | +helpful contributions that mean less work for you. |
| 15 | + |
| 16 | +## Your First Contribution |
| 17 | + |
| 18 | +Unsure where to begin contributing? You can start by looking through some of our issues [listed here](https://github.com/RedisVentures/data-loader/issues). |
| 19 | + |
| 20 | +## Getting Started |
| 21 | + |
| 22 | +Here's how to get started with your code contribution: |
| 23 | + |
| 24 | +1. Create your own fork of this repo |
| 25 | +2. Apply the changes in your fork |
| 26 | +3. _We're still working on a development environment setup -- so stay tuned_ |
| 27 | +4. If you like the change and think the project could use it, send a |
| 28 | + pull request. |
| 29 | + |
| 30 | +### Docker Tips |
| 31 | + |
| 32 | +>COMING SOON |
| 33 | +
|
| 34 | +## How to Report a Bug |
| 35 | + |
| 36 | +### Security Vulnerabilities |
| 37 | + |
| 38 | +**NOTE**: If you find a security vulnerability, do NOT open an issue. |
| 39 | +Email [Tyler Hutcherson (< [email protected]>) ](mailto:[email protected]) instead. |
| 40 | + |
| 41 | +In order to determine whether you are dealing with a security issue, ask |
| 42 | +yourself these two questions: |
| 43 | + |
| 44 | +- Can I access something that's not mine, or something I shouldn't |
| 45 | + have access to? |
| 46 | +- Can I disable something for other people? |
| 47 | + |
| 48 | +If the answer to either of those two questions are *yes*, then you're |
| 49 | +probably dealing with a security issue. Note that even if you answer |
| 50 | +*no* to both questions, you may still be dealing with a security |
| 51 | +issue, so if you're unsure, just email us. |
| 52 | + |
| 53 | +### Everything Else |
| 54 | + |
| 55 | +When filing an issue, make sure to answer these five questions: |
| 56 | + |
| 57 | +1. What version of python are you using? |
| 58 | +2. What version of redis are you using? |
| 59 | +3. What did you do? |
| 60 | +4. What did you expect to see? |
| 61 | +5. What did you see instead? |
| 62 | + |
| 63 | +## How to Suggest a Feature or Enhancement |
| 64 | + |
| 65 | +If you'd like to contribute a new feature, make sure you check our |
| 66 | +issue list to see if someone has already proposed it. Work may already |
| 67 | +be under way on the feature you want -- or we may have rejected a |
| 68 | +feature like it already. |
| 69 | + |
| 70 | +If you don't see anything, open a new issue that describes the feature |
| 71 | +you would like and how it should work. |
| 72 | + |
| 73 | +## Code Review Process |
| 74 | + |
| 75 | +The core team looks at Pull Requests on a regular basis. We will give |
| 76 | +feedback as as soon as possible. After feedback, we expect a response |
| 77 | +within two weeks. After that time, we may close your PR if it isn't |
| 78 | +showing any activity. |
0 commit comments