Skip to content

Commit d8adb8a

Browse files
authored
starting to clean the docs (#1657)
1 parent eaa56b7 commit d8adb8a

File tree

2 files changed

+171
-179
lines changed

2 files changed

+171
-179
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ community contributions!
1010
You may already know what you want to contribute \-- a fix for a bug you
1111
encountered, or a new feature your team wants to use.
1212

13-
If you don\'t know what to contribute, keep an open mind! Improving
13+
If you don't know what to contribute, keep an open mind! Improving
1414
documentation, bug triaging, and writing tutorials are all examples of
1515
helpful contributions that mean less work for you.
1616

@@ -28,7 +28,7 @@ tutorials:
2828

2929
## Getting Started
3030

31-
Here\'s how to get started with your code contribution:
31+
Here's how to get started with your code contribution:
3232

3333
1. Create your own fork of redis-py
3434
2. Do the changes in your fork
@@ -134,19 +134,19 @@ Please try at least versions of Docker.
134134
### Security Vulnerabilities
135135

136136
**NOTE**: If you find a security vulnerability, do NOT open an issue.
137-
Email Andy McCurdy (<sedrik@gmail.com>) instead.
137+
Email [Redis Open Source (<oss@redis.com>)](mailto:[email protected]) instead.
138138

139139
In order to determine whether you are dealing with a security issue, ask
140140
yourself these two questions:
141141

142-
- Can I access something that\'s not mine, or something I shouldn\'t
142+
- Can I access something that's not mine, or something I shouldn't
143143
have access to?
144144
- Can I disable something for other people?
145145

146-
If the answer to either of those two questions are \"yes\", then you\'re
146+
If the answer to either of those two questions are *yes*, then you're
147147
probably dealing with a security issue. Note that even if you answer
148-
\"no\" to both questions, you may still be dealing with a security
149-
issue, so if you\'re unsure, just email Andy at <sedrik@gmail.com>.
148+
*no* to both questions, you may still be dealing with a security
149+
issue, so if you're unsure, just email [us](mailto:oss@redis.com).
150150

151151
### Everything Else
152152

@@ -160,17 +160,17 @@ When filing an issue, make sure to answer these five questions:
160160

161161
## How to Suggest a Feature or Enhancement
162162

163-
If you\'d like to contribute a new feature, make sure you check our
163+
If you'd like to contribute a new feature, make sure you check our
164164
issue list to see if someone has already proposed it. Work may already
165-
be under way on the feature you want \-- or we may have rejected a
165+
be under way on the feature you want -- or we may have rejected a
166166
feature like it already.
167167

168-
If you don\'t see anything, open a new issue that describes the feature
168+
If you don't see anything, open a new issue that describes the feature
169169
you would like and how it should work.
170170

171171
## Code Review Process
172172

173173
The core team looks at Pull Requests on a regular basis. We will give
174174
feedback as as soon as possible. After feedback, we expect a response
175-
within two weeks. After that time, we may close your PR if it isn\'t
175+
within two weeks. After that time, we may close your PR if it isn't
176176
showing any activity.

0 commit comments

Comments
 (0)