Permalink
Browse files

Update contributor guidelines

  • Loading branch information...
1 parent b39d88b commit 13c60f2475e71f800dd365f55c57e1f3d083918a @tyronen tyronen committed with tyronen May 14, 2015
Showing with 27 additions and 8 deletions.
  1. +27 −8 CONTRIBUTING.md
View
@@ -2,6 +2,33 @@
We want to make contributing to this project as easy and transparent as
possible.
+
+## Issues
+We use GitHub issues to track public bugs.
+
+When you report an issue the more information the better. Here are some things that will help you get an answer faster:
+
+- A *title* as well as a body for the issue.
+- A screenshot or video of the problem
+- Logcat output, if your app is crashing.
+- The format of the affected images (JPEG, PNG, GIF, or WebP)
+- Whether the image is an animation
+- Where the images are coming from - network, local file, content provider, asset, or resource.
+- A snippet of the code in question
+- Place code in blocks so that it reads like code:
+
+```
+```java (or xml)
+your code here
+```(terminating backticks)
+```
+
+#### Security bugs
+
+Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
+disclosure of security bugs. In those cases, please go through the process
+outlined on that page and do not file a public issue.
+
## Pull Requests
We actively welcome your pull requests.
@@ -24,14 +51,6 @@ Facebook team member. Once the commit has successfully passed Facebook's interna
test suite, it will be exported back out from Facebook's repository. We endeavour
to do this as soon as possible for all commits.
-## Issues
-We use GitHub issues to track public bugs. Please ensure your description is
-clear and has sufficient instructions to be able to reproduce the issue.
-
-Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
-disclosure of security bugs. In those cases, please go through the process
-outlined on that page and do not file a public issue.
-
## Coding Style
* 2 spaces for indentation rather than tabs
* 100 character line length

0 comments on commit 13c60f2

Please sign in to comment.