ApiDocs: Don't link to code
[reddit.git] / CONTRIBUTING.md
bloba555a91582ffb9140be1cd2844efe797f111881e
1 Thanks for wanting to help make reddit better!
3 Before you submit an issue or pull request, please keep in mind a couple of
4 considerations:
6 1. **Don't use GitHub issues for feature requests**.
7 If you have a feature request, please submit it to
8 [/r/ideasfortheadmins](http://www.reddit.com/r/ideasfortheadmins) instead.
9 Please note that while we do subscribe to /r/ideasfortheadmins, the presence
10 of a response or lack thereof has no indication as to whether the idea will
11 actually get implemented.
13 2. **Don't submit unconfirmed bugs**.
14 Please make sure your bug is an actual bug before reporting it.
15 Unfortunately, things will sometimes break on the operations side of the site
16 (e.g. a database slowing down, or a server being unavailable). These issues may
17 look like a bug, but they are not.  If you're not sure, make a post in
18 [/r/bugs](http://www.reddit.com/r/bugs).
20 3. **DO NOT PUBLICLY REPORT SECURITY BUGS**.
21 If you have found a bug that can in some way compromise the security of the
22 site or its users, please exercise [responsible
23 disclosure](http://www.reddit.com/wiki/whitehat) and e-mail
24 security@reddit.com. We will respond to you as soon as possible. Please note
25 that e-mails which do not pertain to security vulnerabilities in reddit's code
26 will be ignored.
28 4. Please adhere to our [coding
29 standards](https://github.com/reddit/reddit/wiki#change-reddit).
31 5. Please don't submit PRs that are just whitespace, style or readability
32 changes. We prefer to make those changes when we're working with the code
33 in that area anyway.
35 6. Please don't submit minor tweaks to text on the site, such as changes to
36 punctuation, spacing or wording. Any string changes will cause all previous
37 translations of that string to other languages to be invalidated, so we try
38 to only change strings when the difference is significant.
40 After you submit your issue or request, we'll take a look and it and get back
41 to you in a few days. If you have any questions, feel free to ask us! We're
42 readily available:
44 * [/r/redditdev](http://www.reddit.com/r/redditdev)
45 * [reddit-dev mailing list](https://groups.google.com/forum/?fromgroups#!forum/reddit-dev)
46 * [#reddit-dev](irc://irc.freenode.net/reddit-dev) on [freenode](http://www.freenode.net/).
47 Remember to use [proper IRC etiquette](http://geoff.greer.fm/2012/05/19/programmer-irc-etiquette/).