|
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Introduction |
| 4 | + |
| 5 | +We appreciate your interest in contributing to NRedisStack. |
| 6 | +Community contributions mean a lot to us. |
| 7 | + |
| 8 | +## Contributions we need |
| 9 | + |
| 10 | +You may already know how you'd like to contribute, whether it's a fix for a bug you |
| 11 | +encountered, or a new feature your team wants to use. |
| 12 | + |
| 13 | +If you don't know where to start, consider improving |
| 14 | +documentation, triaging bugs, or writing tutorials. These are all examples of |
| 15 | +helpful contributions that mean less work for you. |
| 16 | + |
| 17 | +## Your First Contribution |
| 18 | + |
| 19 | +Unsure where to begin contributing? You can start by looking through |
| 20 | +[help-wanted |
| 21 | +issues](https://github.com/redis/NRedisStack/labels/help-wanted). |
| 22 | + |
| 23 | +Never contributed to open source before? Here are a couple of friendly |
| 24 | +tutorials: |
| 25 | + |
| 26 | +- <http://makeapullrequest.com/> |
| 27 | +- <http://www.firsttimersonly.com/> |
| 28 | + |
| 29 | +## Getting Started |
| 30 | + |
| 31 | +Here's how to get started with your code contribution: |
| 32 | + |
| 33 | +1. Create your own fork of NRedisStack |
| 34 | +2. Do the changes in your fork |
| 35 | +3. Write your tests |
| 36 | + |
| 37 | +4. Use the `docker run -p 6379:6379 -it redis/redis-stack-server:edge` as your local environment for running the functional tests. |
| 38 | +5. Make sure your tests pass using `dotnet test' |
| 39 | +6. Push your changes to GitHub |
| 40 | +7. Open a pull request |
| 41 | + |
| 42 | +## Testing |
| 43 | + |
| 44 | +Call `dotnet test` to run all tests |
| 45 | + |
| 46 | +to test specific test you can use `--filter` flag: |
| 47 | +```bash |
| 48 | +dotnet test --filter <YourTestName> |
| 49 | +``` |
| 50 | + |
| 51 | +If you want to run your tests against a specific host and port, you can do it thus: |
| 52 | +```bash |
| 53 | +dotnet test --environment="REDIS=<redisServer:port>" |
| 54 | +``` |
| 55 | +e.g: |
| 56 | +```bash |
| 57 | +dotnet test --environment="REDIS=172.17.0.1:6379" |
| 58 | +``` |
| 59 | +## How to Report a Bug |
| 60 | + |
| 61 | +### Security Vulnerabilities |
| 62 | + |
| 63 | +**NOTE**: If you find a security vulnerability, do NOT open an issue. |
| 64 | +Email [Redis Open Source ( <[email protected]>) ](mailto:[email protected]) instead. |
| 65 | + |
| 66 | +In order to determine whether you are dealing with a security issue, ask |
| 67 | +yourself these two questions: |
| 68 | + |
| 69 | +- Can I access something that's not mine, or something I shouldn't |
| 70 | + have access to? |
| 71 | +- Can I disable something for other people? |
| 72 | + |
| 73 | +If the answer to either of those two questions are *yes*, then you're |
| 74 | +probably dealing with a security issue. Note that even if you answer |
| 75 | +*no* to both questions, you may still be dealing with a security |
| 76 | +issue, so if you're unsure, just email [us ](mailto:[email protected]). |
| 77 | + |
| 78 | +### Everything Else |
| 79 | + |
| 80 | +When filing an issue, make sure to answer these five questions: |
| 81 | + |
| 82 | +1. What version of NRedisStack are you using? |
| 83 | +2. What version of redis are you using? |
| 84 | +3. What did you do? |
| 85 | +4. What did you expect to see? |
| 86 | +5. What did you see instead? |
| 87 | + |
| 88 | +## Suggest a feature or enhancement |
| 89 | + |
| 90 | +If you'd like to contribute a new feature, make sure you check our |
| 91 | +issue list to see if someone has already proposed it. Work may already |
| 92 | +be underway on the feature you want or we may have rejected a |
| 93 | +feature like it already. |
| 94 | + |
| 95 | +If you don't see anything, open a new issue that describes the feature |
| 96 | +you would like and how it should work. |
| 97 | + |
| 98 | +## Code review process |
| 99 | + |
| 100 | +The core team regularly looks at pull requests. We will provide |
| 101 | +feedback as as soon as possible. After receiving our feedback, please respond |
| 102 | +within two weeks. After that time, we may close your PR if it isn't |
| 103 | +showing any activity. |
0 commit comments