Mirror/codiad
1
0
Fork 0
mirror of https://github.com/xevidos/codiad.git synced 2024-12-22 22:02:15 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #6 from ConnorSkees/patch-1

Browse source 
Fix typos in CONTRIBUTING.md
This commit is contained in:
Xevidos 2020-01-06 21:33:32 -05:00 committed by GitHub
commit d9aff8e892
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -1,6 +1,6 @@
# How to Contribute
Your contributions are welcome and we're very open about how contributions are made, however, to keep order to things please take the following into consideration:
Your contributions are welcome and we're very open about how contributions are made; however, to keep order to things please take the following into consideration:
* Check the issues to ensure that someone else isn't already working on the bug or feature
* Submit an issue for bugs and feature additions before you start with it
@ -8,18 +8,18 @@ Your contributions are welcome and we're very open about how contributions are m
There is an established format for `components` which utilizes one JS (`init.js`) and one CSS (`screen.css`) which is handled by the loader file. Any other resources used should be loaded or accessed from one of these.
**Don't Reinvent the Wheel!** There's an API and defined, easy-to-understand set of methods for a reason - use them.
**Don't Reinvent the Wheel!** There's an API and a defined, easy-to-understand set of methods for a reason - use them.
Stick to the conventions defined in other components as closely as possible.
* Utilize the same commenting structure
* Use underscores in namespaces instead of interCaps
* Use intend with a tab character in your code
* Use underscores in namespaces instead of camelCase
* Indent using tabs
* When working with the editor utilize the `active` object whenever possible instead of going direct to the `editor`
**Javascript Formatting**
In order to maintain a consistant code structure to the code across the application please follow the wordpress standard, or run any changes through [JSBeautifier] (http://jsbeautifier.org/) with the settings below.
In order to maintain a consistent code structure to the code across the application, please follow the WordPress standard, or run any changes through [JSBeautifier] (http://jsbeautifier.org/) with the settings below.
{
"brace_style": "collapse",
@ -50,4 +50,4 @@ If you have questions, please ask. Submit an issue or [contact us directly](mail
**PHP Formatting**
In order to maintain a consistant code structure we follow WordPress standards.
In order to maintain a consistent code structure we follow WordPress standards.