commit 53b0a9ad7a7efdcaefef32d9349c8e4bcfbf8da2
parent 1ac6b41990ac1f0fe59b1e2e21254eb606dcd30d
Author: Kevin Barabash <kevinb7@gmail.com>
Date: Wed, 1 Jul 2015 20:15:03 -0600
Update CONTRIBUTING.md
added "Pull Requests" section with some guidelines, plus some addition code style guidelines.
fix grammar and be more specific about splitting large pull request
Update CONTRIBUTING.md
Diffstat:
1 file changed, 9 insertions(+), 0 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -100,9 +100,18 @@ Code
- 80 character line length
- commas last
- declare variables in the outermost scope that they are used
+ - camelCase for variables in JavaScript
+ - snake_case for variables in Python
In general, try to make your code blend in with the surrounding code.
+## Pull Requests
+
+ - link back to the original issue(s) whenever possible
+ - new commands should be added to the [wiki](https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX)
+ - commits should be squashed before merging
+ - large pull requests should be broken into separate pull requests (or multiple logically cohesive commits), if possible
+
## CLA
In order to contribute to KaTeX, you must first sign the CLA, found at www.khanacademy.org/r/cla