Commit 6d22f291abb9bc0a290242f3a688d56a43039a9e

Lea Verou 2013-11-29T05:57:29

Added instructions for contributors

diff --git a/README.md b/README.md
index 30e888e..a00aa8f 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,17 @@ Prism is a lightweight, robust, elegant syntax highlighting library. It's a spin
 You can learn more on http://prismjs.com/.
 
 Why another syntax highlighter?: http://lea.verou.me/2012/07/introducing-prism-an-awesome-new-syntax-highlighter/#more-1841
+
+## Contribute to Prism!
+
+Prism depends on community contributions to expand and cover a wider array of use cases. If you like it, considering giving back by sending a pull request. Here are a few tips:
+
+- Read the [documentation](http://prismjs.com/extending.html). Prism was designed to be extensible.
+- Do not edit prism.js, it’s just the version of Prism used by the Prism website and is built automatically. Limit your changes to the unminified files in the components/ folder. The minified files are also generated automatically.
+- Currently the build system building prism.js and the minified files is just a bunch of local settings in CodeKit. If someone wants to help export them to a config file, please contact me by opening an issue.
+- Please follow the code conventions used in the files already. For example, I use [tabs for indentation and spaces for alignment](http://lea.verou.me/2012/01/why-tabs-are-clearly-superior/). Opening braces are on the same line, closing braces on their own line regardless of construct. There is a space before the opening brace. etc etc.
+- Please try to err towards more smaller PRs rather than few huge PRs. If a PR includes changes I want to merge and changes I don't, handling it becomes difficult.
+- My time is very limited these days, so it might take a long time to review longer PRs (short ones are usually merged very quickly), especially those modifying the Prism Core. This doesn't mean your PR is rejected.
+- If you contribute a new language definition, you will be responsible for handling bug reports about that language definition. Soon I plan to add usernames of project owners for themes, plugins and language definitions so this becomes more clear to users.
+
+Thank you so much for contributing!!