some coding principle in web

1. WEB
CODING
PRINCIPLE

2. PRINCIPLE
Readable
Maintainable
Debuggable (include Testable)
unit test !?

3. BROWSER
Full HTML5 Solution
Chrome
Firefox
Safari
IE edge
IE6.0~11.0 !?

4. ENVIRONMENT
PHP 5.3.x
Apache 2.2.x
Mysql 5.0.x
XAMPP 1.7.7

5. FRAMEWORK
CodeIgniter
MVC
• Controller: HTTP request, 參數檢查, Model & View邏輯
• Model: 資料新增, 刪除,修改
• View: 顯示頁面
• css class instead of style

6. DATABSE
欄位和資料表要寫註解
PDO
notORM !?
Other ORM
• http://datamapper.wanwizard.eu
• http://www.doctrine-project.org

7. URL

8. API
Return JSON
REST

9. NAMING
命名需要有意義
PSR
http://www.php-fig.org/psr/psr-2
CI
• http://www.codeigniter.org.tw/user_guide/general/styleguide.
html
4 space instead of tab

10. CSS
RWD
• font-size: em
• width, height: grid system
themes
• default
• css
• main.css
• img
https://github.com/doggy8088/CSS-
Guidelines/blob/master/README.md

11. JAVASCRIPT
js
• jquery…etc
• 一般寫在 view html 最後
• 較大寫成獨立 js
http://jstherightway.org/

12. CONFIGURE
global.php
• 自定的 config

13. DOCUMENT
docs
• api
• API_NAME.md
• INDEX.md
• INSTALL.md
• README.md
• UPDATE_NOTICE.md

14. PATCH
patch
• php command

15. COMMAND
bin
• crontab used
• php command tools

16. COST OF FIXING
SOFTWARE BUGS

17. TESTING SOP
White-Box Testing
• Data flow
• Control flow
Black-Box Testing
• Staging test
• 合併到 develop 會自動更新到 staging
Unit Testing
TDD

18. GIT FLOW
http://nvie.com/posts/a-successful-git-branching-model/

19. COMMIT SOP
1. 在本地端測試自己新的功能是”正確”完成的
2. Git Pull 取得最新的狀態
3. Commit Code 請一隻一隻程式確定
• 禁用 commit –a
4. 一隻一隻程式去確定這次改變的 Diff
5. 寫 log
6. Merger new branch to Develop
7. 到 Staging 去驗證本次寫的功能

20. MULTI LANGUAGE
語言
• 繁體
• 简体
• English
applicationlanguage$languagemessage_lang.php
• applicationconfigconfig.php

21. STRING TABLE
• 請一開始就使用 String table 寫法
• 英文、阿拉伯數字和中文中間空一格(半形)
• 標點符號請用全形
• PDF、MP3 統一使用大寫
• 多國語言請僅量不要使用 string 組合
• 有變數的提示訊息使用格式化的 string 處理
• sprintf : http://www.php.net/manual/en/function.sprintf.php