diff options
author | Chayim <chayim@users.noreply.github.com> | 2021-10-28 12:45:35 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-28 12:45:35 +0300 |
commit | d8adb8af45248ad4597f47ac871ce69990022046 (patch) | |
tree | f279bc5cd60ae6d195a8f50477d26f54d1cea7e3 /CONTRIBUTING.md | |
parent | eaa56b7d721182541bab087a6d61304c778f7ea9 (diff) | |
download | redis-py-d8adb8af45248ad4597f47ac871ce69990022046.tar.gz |
starting to clean the docs (#1657)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31170f3..af067e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ community contributions! You may already know what you want to contribute \-- a fix for a bug you encountered, or a new feature your team wants to use. -If you don\'t know what to contribute, keep an open mind! Improving +If you don't know what to contribute, keep an open mind! Improving documentation, bug triaging, and writing tutorials are all examples of helpful contributions that mean less work for you. @@ -28,7 +28,7 @@ tutorials: ## Getting Started -Here\'s how to get started with your code contribution: +Here's how to get started with your code contribution: 1. Create your own fork of redis-py 2. Do the changes in your fork @@ -134,19 +134,19 @@ Please try at least versions of Docker. ### Security Vulnerabilities **NOTE**: If you find a security vulnerability, do NOT open an issue. -Email Andy McCurdy (<sedrik@gmail.com>) instead. +Email [Redis Open Source (<oss@redis.com>)](mailto: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 +- 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 +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 Andy at <sedrik@gmail.com>. +*no* to both questions, you may still be dealing with a security +issue, so if you're unsure, just email [us](mailto:oss@redis.com). ### Everything Else @@ -160,17 +160,17 @@ When filing an issue, make sure to answer these five questions: ## How to Suggest a Feature or Enhancement -If you\'d like to contribute a new feature, make sure you check our +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 under way on the feature you want \-- or we may have rejected a +be under way 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 +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 looks at Pull Requests on a regular basis. We will give feedback as as soon as possible. After feedback, we expect a response -within two weeks. After that time, we may close your PR if it isn\'t +within two weeks. After that time, we may close your PR if it isn't showing any activity. |