tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Moved coding conventions docs into contributing folder

Browse Source 
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
This commit is contained in:
Ingo Schommer 2016-06-03 10:53:35 +12:00
parent a4f64d01c2
commit c96e031367
7 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/02_Developer_Guides/09_Security/04_Secure_Coding.md
View File

@ -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.

4
docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md
View File

@ -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

7
docs/en/05_Contributing/01_Code.md
View File

@ -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

5
docs/en/05_Contributing/10_Coding_Conventions.md Normal file
View File

@ -0,0 +1,5 @@
# Coding Conventions
* [PHP Coding Conventions](php_coding_conventions)
* [CSS Coding Conventions](css_coding_conventions)
* [JavaScript Coding Conventions](javascript_coding_conventions)

4
docs/en/00_Getting_Started/06_JavaScript_Coding_Conventions.md → docs/en/05_Contributing/11_JavaScript_Coding_Conventions.md
View File

@ -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)

4
docs/en/00_Getting_Started/07_CSS_Coding_Conventions.md → docs/en/05_Contributing/12_CSS_Coding_Conventions.md
View File

@ -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/)

2
docs/en/00_Getting_Started/05_Coding_Conventions.md → docs/en/05_Contributing/13_PHP_Coding_Conventions.md
View File

@ -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)