From c96e031367e439591e08aa1f1a8a770cd63e667b Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Fri, 3 Jun 2016 10:53:35 +1200 Subject: [PATCH] Moved coding conventions docs into contributing folder Also created a contributing/coding_conventions landing page separately from the PHP ones, since we now need to account for JS and CSS conventions as well --- .../en/02_Developer_Guides/09_Security/04_Secure_Coding.md | 2 +- .../02_CMS_Architecture.md | 4 ++-- docs/en/05_Contributing/01_Code.md | 7 ++++--- docs/en/05_Contributing/10_Coding_Conventions.md | 5 +++++ .../11_JavaScript_Coding_Conventions.md} | 4 ++-- .../12_CSS_Coding_Conventions.md} | 4 ++-- .../13_PHP_Coding_Conventions.md} | 2 +- 7 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 docs/en/05_Contributing/10_Coding_Conventions.md rename docs/en/{00_Getting_Started/06_JavaScript_Coding_Conventions.md => 05_Contributing/11_JavaScript_Coding_Conventions.md} (94%) rename docs/en/{00_Getting_Started/07_CSS_Coding_Conventions.md => 05_Contributing/12_CSS_Coding_Conventions.md} (95%) rename docs/en/{00_Getting_Started/05_Coding_Conventions.md => 05_Contributing/13_PHP_Coding_Conventions.md} (99%) diff --git a/docs/en/02_Developer_Guides/09_Security/04_Secure_Coding.md b/docs/en/02_Developer_Guides/09_Security/04_Secure_Coding.md index afd072867..2c98d68f9 100644 --- a/docs/en/02_Developer_Guides/09_Security/04_Secure_Coding.md +++ b/docs/en/02_Developer_Guides/09_Security/04_Secure_Coding.md @@ -7,7 +7,7 @@ See our "[Release Process](/contributing/release_process#security-releases) on h ## SQL Injection -The [coding-conventions](/getting_started/coding_conventions) help guard against SQL injection attacks but still require developer +The [coding-conventions](/contributing/coding_conventions) help guard against SQL injection attacks but still require developer diligence: ensure that any variable you insert into a filter / sort / join clause is either parameterised, or has been escaped. diff --git a/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md b/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md index 5e5e39dcf..8e38d5818 100644 --- a/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md +++ b/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md @@ -45,8 +45,8 @@ Please make sure you build all files before submitting a pull request! ## Coding Conventions -Please follow our [CSS](/getting_started/css_coding_conventions) -and [JavaScript](/getting_started/javascript_coding_conventions) +Please follow our [CSS](/contributing/css_coding_conventions) +and [JavaScript](/contributing/javascript_coding_conventions) coding conventions. ## Sprites diff --git a/docs/en/05_Contributing/01_Code.md b/docs/en/05_Contributing/01_Code.md index 67f049d57..2b57c13f2 100644 --- a/docs/en/05_Contributing/01_Code.md +++ b/docs/en/05_Contributing/01_Code.md @@ -105,7 +105,8 @@ When contributing a backwards incompatible change, you must raise it against the ### The Pull Request Process Once your pull request is issued, it's not the end of the road. A [core committer](/contributing/core_committers/) will most likely have some questions for you and may ask you to make some changes depending on discussions you have. -If you've been naughty and not adhered to the coding conventions, expect a few requests to make changes so your code is in-line. +If you've been naughty and not adhered to the [coding conventions](coding_conventions), +expect a few requests to make changes so your code is in-line. If your change is particularly significant, it may be referred to the [mailing list](https://groups.google.com/forum/#!forum/silverstripe-dev) for further community discussion. @@ -113,7 +114,7 @@ A core committer will also "label" your PR using the labels defined in GitHub, t #### GitHub Labels -The current GitHub labels are grouped into 5 sections: +The current GitHub labels are grouped into five sections: 1. *Changes* - These are designed to signal what kind of change they are and how they fit into the [Semantic Versioning](http://semver.org/) schema 2. *Impact* - What impact does this bug/issue/fix have, does it break a feature completely, is it just a side effect or is it trivial and not a bit problem (but a bit annoying) @@ -166,7 +167,7 @@ After you have edited the file, GitHub will offer to create a pull request for y ## Check List -* Adhere to our [coding conventions](/getting_started/coding_conventions) +* Adhere to our [coding conventions](/contributing/coding_conventions) * If your patch is extensive, discuss it first on the [silverstripe-dev google group](https://groups.google.com/group/silverstripe-dev) (ideally before doing any serious coding) * When working on existing tickets, provide status updates through ticket comments * Check your patches against the "master" branch, as well as the latest release branch diff --git a/docs/en/05_Contributing/10_Coding_Conventions.md b/docs/en/05_Contributing/10_Coding_Conventions.md new file mode 100644 index 000000000..a71485fc1 --- /dev/null +++ b/docs/en/05_Contributing/10_Coding_Conventions.md @@ -0,0 +1,5 @@ +# Coding Conventions + + * [PHP Coding Conventions](php_coding_conventions) + * [CSS Coding Conventions](css_coding_conventions) + * [JavaScript Coding Conventions](javascript_coding_conventions) diff --git a/docs/en/00_Getting_Started/06_JavaScript_Coding_Conventions.md b/docs/en/05_Contributing/11_JavaScript_Coding_Conventions.md similarity index 94% rename from docs/en/00_Getting_Started/06_JavaScript_Coding_Conventions.md rename to docs/en/05_Contributing/11_JavaScript_Coding_Conventions.md index eeb0f0e07..9d06b02ce 100644 --- a/docs/en/00_Getting_Started/06_JavaScript_Coding_Conventions.md +++ b/docs/en/05_Contributing/11_JavaScript_Coding_Conventions.md @@ -42,5 +42,5 @@ and can be checked locally via `npm run lint`. ## Related -* [PHP Coding Conventions](/getting_started/coding_conventions) -* [CSS Coding Conventions](/getting_started/css_coding_conventions) +* [PHP Coding Conventions](/contributing/php_coding_conventions) +* [CSS Coding Conventions](/contributing/css_coding_conventions) diff --git a/docs/en/00_Getting_Started/07_CSS_Coding_Conventions.md b/docs/en/05_Contributing/12_CSS_Coding_Conventions.md similarity index 95% rename from docs/en/00_Getting_Started/07_CSS_Coding_Conventions.md rename to docs/en/05_Contributing/12_CSS_Coding_Conventions.md index 2324b87c1..3da0136fd 100644 --- a/docs/en/00_Getting_Started/07_CSS_Coding_Conventions.md +++ b/docs/en/05_Contributing/12_CSS_Coding_Conventions.md @@ -64,6 +64,6 @@ consider porting them over into the new structure. Otherwise, follow these conve ## Related -* [PHP Coding Conventions](/getting_started/coding_conventions) -* [JavaScript Coding Conventions](/getting_started/javascript_coding_conventions) +* [PHP Coding Conventions](/contributing/php_coding_conventions) +* [JavaScript Coding Conventions](/contributing/javascript_coding_conventions) * [Browser support](/getting_started/server_requirements/) diff --git a/docs/en/00_Getting_Started/05_Coding_Conventions.md b/docs/en/05_Contributing/13_PHP_Coding_Conventions.md similarity index 99% rename from docs/en/00_Getting_Started/05_Coding_Conventions.md rename to docs/en/05_Contributing/13_PHP_Coding_Conventions.md index 13d962c66..b4c7274e5 100644 --- a/docs/en/00_Getting_Started/05_Coding_Conventions.md +++ b/docs/en/05_Contributing/13_PHP_Coding_Conventions.md @@ -458,5 +458,5 @@ which are licensed under BSD (see [license](http://framework.zend.com/license)). ## Related - * [JavaScript Coding Conventions](/getting_started/javascript_coding_conventions) + * [JavaScript Coding Conventions](/contributing/javascript_coding_conventions) * [Reference: CMS Architecture](/developer_guides/customising_the_admin_interface/cms_architecture)