Last active
August 29, 2015 14:01
-
-
Save kprovance/9270cedb50bebaf65208 to your computer and use it in GitHub Desktop.
contribution guidelines
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use curly brackets for sections. | |
No open ended if/foreach loops, it's hard to read. | |
Example: | |
function myFunction() { | |
echo 'hi!'; | |
} | |
Use spaces for in-line statements: | |
$var = get_data( array( 'redux' ) ); | |
NO TABS! | |
One indent = four spaces. | |
Increase version number for pulls in the following files: | |
framework.php | |
class.redux-plugin.php | |
redux-framework.php | |
Add change to README.MD in this format: | |
#Issue only needed if referencing an issue number. | |
Please use spaces necessary so data after [Fixed|Added|Modified|Removed] uniformly lines up. | |
= major.minor.version.build = | |
* [Fixed|Added|Modified|Removed]: [#issue] - Changes made. | |
Example: | |
= 3.2.9.13 = | |
Fixed: Something that broke. | |
Modified: #1234 - Something else that wasn't working. | |
Please make your code readble. Avoid clumping block of code together. Try to leave a blank line after a loop sections. Try to group variables together at the top of a function. | |
COMMENT! COMMENT COMMENT! It makes it easier for the next guy to know what you added/changed. If possible, place your comments above the line of code it explains. | |
Do not edit ANY CSS directly. Edit the included LESS files and compile (if you are unable to compile, we can do it for you). | |
When editing any JS file, it will need to be minified and included with your pull. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment