lyrasoft / development-tools

LYRASOFT Development Tools

LYRASOFT Development Tools

工作平台入口

• Google Doc https://drive.google.com/drive/u/0/folders/0B-nrh2dPfVAQNHpjMXFTODBnLXM
• Slack https://megamount.slack.com
• Trello https://trello.com/megamount
• Mega https://mega.nz/
• Document http://docs.lyrasoft.net/

CodeSniffer

The PHP_CodeSniffer Package for LYRA Developer Team.

Installation

PhpStorm Installation

PHPUnit

Guide

Not yet...

PHPStorm

File Template

特別編寫過的 Comment 模板幫助快速產生符合標準的區塊註解(請搭配 Code Style 使用)

下載後匯入 setting (只包含 File Template 而已，其他不會覆蓋): File-Templates.jar

get-pr

Getting Started

Download this file.

$ wget https://gist.githubusercontent.com/asika32764/5824bc66a6756dc3031e/raw/92f072b3c1737553bf08be2fa9695c094e607ae6/get-pr

Then mv to /usr/local/bin (Windows should put in a folder which in Environment Variable Path, I'm used to put in C:\bin)

$ chmod +x get-pr
$ mv get-pr /usr/local/bin/get-pr

cd to your git project

Then execute：

$ get-pr upstream 123
$ git checkout pr-123

OK we will pull and checkout to this PR.

Usage:

$ get-pr {remote-name} {PR-ID}

It is convenience to review PR or contribute to others PR.

Image

development-tools's Issues

StackScript 修改事項

• Node.js use 16.x
• php use 8
• mode rewrite enable
• apache log
• Install lyra and composer install
• Use for Ubuntu 22.04
• php.ini preset
• No phpmyadmin

開案會議 Tamplate 2016/12/13開會後定稿，公告執行

百岳國際會議記錄－開案會議議程討論

會議名稱：開案會議議程討論
日期：2016.12.13
主席：Stuart
記錄：Ada

出席人員：Stuart、Burce、Eric、Anny、Ada

會議開始時間：15:36

會議議程：

會議前準備：

1. 三天前文件備齊由召集人發出會議通知
2. 開啟google 專案案件資料夾
3. Slack channel，invite member，貼出會議通知以及相關文件
4. 專案語言框架
5. 第三方串接相關使用預先確定（server, smtp, 金流 , Oauth … 等）
6. 製作文件（需求清單、wireframe、sitemap、schema、mockup）
7. PM列重大議程（結案時程、內部驗收時程、前後台完成時程），先列在會議紀錄上

會議中討論事項：

1. 專案執行(詳細執行期程) PM 帶簡報關於每頁細部功能（包含需求確認，user story，wireframe，設計稿），相關重要期程，確定每一個相關的milestone。
2. 與會人員發問提出相關問題。

會議後：

1. 開啟github專案，設立各個時程上的milestone
2. 改用專案 README https://github.com/lyrasoft/development-tools/tree/master/Windwalker-Project
3. Google calendar標記milestone時間點
4. 把 Table Schema, Wireframe 等文件貼上 README (直連 Slack)
5. 設定 preparedev 等 script (參考 earth)
6. 放上模板檔案在 /theme 資料夾
7. 建立常用 Label (PR Attached, Priority 等等)
8. 建立檢討用會議記錄

名詞定義：

1. Wireframe：應加入設計，功能位置不應有太過大的變動（如不能由下變成左，但可以都在下方但靠右或置中等）
2. 第三方串接：包含物流、社群等等
3. 會議記錄：遇到問題時就先編輯到會議記錄

會議後執行事項：

1. 在 develop-tool 建立相關常用 Label 討論串
   （Link:https://github.com/lyrasoft/development-tools/issues/21）

會議結束：4 :25

原始紀錄見：https://docs.google.com/document/d/13KDTNS960SdsSSbmBEHcrHh9riq0cS2QRv4Ri61czjc/edit#

研究 GoAccess

See https://goaccess.io/

用 Portal 取代現有的服務

• Passpack
• 文件網站
• 伺服器集中管理

其他待討論

See https://github.com/lyrasoft/portal/issues/19

[統計] 開發上比較耗時的部分

這邊先統計各專案開發上較耗時的部分，研究看看能不能靠技術升級來補足 （先排除訓練不足與框架 bug 的狀況）

• 複雜前端介面
  • Form 的動態處理
  • DVS 前端大檔案上傳 (個案)
  • Eng4tw 的 Markdown Editor, Google Map 與英文朗讀功能 (個案)
• UI 排版
• 初始化專案時配置 Schema 與後台 Field Definition 建立等等
• 第三方 API 整合
• Joomla 後台的權限管理與功能隱藏

@supergud 能否補充 easy2go 遇到的問題？

自動加裝 github ssh 的工具

感覺很多新手會需要

下完指令直接吐出 ssh key 給使用者複製

@kiyayeh @supergud 覺得?

[討論] 啟用 GitHub Issue Template

一樣需要有人處理這件事

• See https://github.com/blog/2111-issue-and-pull-request-templates
• See also https://github.com/joomla/joomla-cms/tree/staging/.github

修改 JS Code style 大括號換行規定

目前我們的規定是 Allman style，也就是開頭大括號強制換一行

由於未來準備跟主流 Code style 整合，我們可以在年底的時候，預先把大括號換行這個最大的風格差異改過來 （但 php 還是先維持 Allman）

需要更改的部份是

• PHPStorm Code style 設定檔並匯出 https://github.com/lyrasoft/development-tools/blob/master/Editor/PHPStorm/CodeStyle.jar
• LYRASOFT JS Coding Standards 文件 https://github.com/lyrasoft/coding-standards/blob/master/javascript.md

完成後會發正式公告，則所有人「新寫」的程式碼必須符合規定

如果改到舊的程式碼，也必須至少將該檔案的 Style 轉成最新風格

關於 ubold 與 inspinia 模版

https://github.com/lyrasoft/ubold
https://github.com/lyrasoft/inspinia

這兩個 repo 不建議裝整個 earth 上去，這樣未來 earth 更新時無法同步

@kiyayeh @supergud

[Phoenix] 與佈景 jQuery 衝突的問題

Ubold 用的是 jQuery 2.x，Earth 內裝的是 1.11.x

目前 Earth 直接升級成 2.x 是沒問題的。但要注意升級上去後會無法支援 IE 6/7/8

要討論是否把 jQuery 2 裝進核心，還是維持 1.x ，有需要時自己升級然後改佈景的 code?

See issue in phoenix repository windwalker-io/phoenix#208

Use $asset->alias() to override jQuery or any scripts
http://windwalker.io/documentation/3.x/services/asset.html#alias

專案開工會議 準備事項及內容

會議記錄：https://docs.google.com/document/d/1LvjC2GhfcHyleud0NV5z0a61d-pQh_cFT10JMjCoHTA/edit

相關修改討論請在本串下：

會議前：

1. 三天前文件備齊由召集人發出會議通知
2. 開啟google 專案案件資料夾
3. Slack channel, invite member
4. 製作文件（wireframe, sitemap, schema）
5. Pm列重大議程，先列在會議紀錄上

會議中討論事項：

1. 專案使用工具及語言框架
2. 第三方串接相關使用預先確定
3. 專案執行(詳細執行期程) PM 帶簡報關於每頁細部功能，相關重要期程
4. 與會人員發問提出相關問題

會議後：

1. 開啟github專案，設立各個時程上的milestone
2. Google calendar標記時間點

建立 Universal Deploy tools

由於目前 deploy 都要手動 ssh 到機器上，可以考慮建立比較快的網站更新與 restore 工具

Spec

• 可以快速複製 install code 裝到機器上
• 可以自己寫安裝指令集
• 執行一次就會把所有要做的事處理好 git pull, composer install, migrate, sync script
• 需要搭配可以快速連結到主機的 ssh 工具(例如 Windows 上的 XShell)，或是可以自己做一個整合的 Web Schell 介面，把所有主機與空間整合在一起

以下開放補充與討論

GitHub 常用 Labels 列表

• Bug（通常為紅色）

• Duplicate （issue 被重複開啟時使用）

• High Priority （緊急時，時限只有一天的 issue）

• Low Priority （需要修正，但不太影響整個案子或可待下個階段再修正）

• PR Attached （已發 PR 待review，通常為橘色）

• PrepareDev （需要跑 preparedev 時）

• Migration （有動到資料庫修改的都要貼，通常為黃色）

• Wont Fix （不會修正的功能，通常為白色）

• Composer Install （需要 composer install 時）

• 切版（表該 issue 為切版）

• Work In Process（先發ＰＲ但還在製作中）

• Code Review（PR 需要 code review）

• PM Test（PR 需要請人測試）

• Question（該 issue 內容上有疑問或 PR 內有功能面或設計面的問題需要修改，通常為粉紅色）

• Code Fix（需要修正 code style）
  --
  請協助增補以及修正說明使用時機

[WW] record 文件錯誤

按照文件操作結果比預期的先爆掉。
Record 在 load 那一瞬間找不到就會先炸開。

2017 年的技術調整

今年底開始會逐步進行的技術調整，以下先條列出來，未來會再增修

由 LESS 改用 SCSS

由於 Ionic 與許多我們未來可能採用的前端專案轉向使用 SASS 體系，未來將導入 SCSS 作為主要的 CSS Compiler。需等待 Windwalker 與 Phoenix 重寫

暫時不考慮 SASS ，SCSS 與原生 CSS 有較高相容性，無須重新訓練。但在公告前正式專案還是必須以 LESS 為主。

大型 SPA 的技術選擇

會以 Vue 為主體，與 Windwalker 和 jQuery 的整合較佳。 Angular2 + TypeScript 的學習門檻過高，需要半年以上的訓練時間。

日常開發還是 jQuery 為主，才能與 UI 設計師整合工作流。

調整 Coding Style

除了 PHP 維持原有風格外，JS 與 CSS 將採用一般括號風格，前括號不用再換行 (但正式公告前必須維持舊寫法，避免大家寫出不同的 code)

PHP 有可能在 Windwalker 4 以後改用 PSR-2 風格，但要看未來的社群狀況做調整

測試與持續整合

預計也要半年的時間訓練大家才能上手

主機開始正式佈署 Vesta CP

但需要更多時間試用

---

2016-09-28

TypeScript & PHP7

全面導入型別檢查，前後端編程風格統一化
https://zhongsp.gitbooks.io

---

後續待補充

Add create-flow to auto gen a set of profiles

Similar to git-flow

[公告] 以後用這邊作為開發技術討論區與 bug 集中回報區

@kiyayeh @supergud @tedca886

跟技術有關的內部工作我們集中在這邊討論吧，請大家把這個 repo 加入書籤

---

Bug 統一回報

所有套件在這邊統一回報 bug 或新功能請求，我再各自整理到 repo 上面

標題統一用 [套件名] 問題說明 ，例如 [Ezset] Facebook Like 數量不正確

內文標準請至少附上錯誤訊息或錯誤畫面截圖，如果可以的話稍微描述一下如何重現錯誤或者有沒有平台差異，我有修復時再 ref commit 或 PR 大家就知道已經修好了

流程討論

標題統一用 [Discuss] 新專案建立流程討論 這樣的格式

內文可提出自己的第一版建議，再交由大家用 Github 的投票機制討論

內部工作討論

同上，建立 issue 當作討論串，確認方向後再到專案管理平台開 task 工作

公告

[公告] 開頭的要求所有人閱讀後 +1

README

可能要在 README 上面列一下我們的各個工作平台網址，方便大家從這裡做為入口平台開始各項作業

有沒有人要認領這項工作?

隱藏?

要把這個 repo 轉成 private 嗎?

[Draft] jQuery / Vue 編寫規範

過去 jQuery 的編寫規範是經過長時間發展的，還沒有正式文件直接說明

目前 Vue 也還在發展穩定寫法，並且還需要與 jQuery 交互作用，未來必須要有正式的 Guide 規範所有人採用相同的模式編寫 JS 物件、命名、引入方式等等

先等 #15 完成後開始擬定草案，預計 2017 年中才能完成正式規範

更新 Warder & Luna Table Schema

在這邊
https://docs.google.com/spreadsheets/d/1BFMe3fM0EHCRltKbFtJXdx-Q3AoVyKaUQwH-iuEJGUM/edit#gid=727062906

以後新專案可以來這裡複製

重建 GiantServer 改用 Vesta CP

[公告] Pull Request 命名原則

• PR Title
  PR 標題的格式如下

  [PR 類型] PR 標題
  

  PR 類型包括如下

  類型	範例
  BugFix	[BugFix] 修正某個壞掉的功能
  HotFix	[HotFix] 緊急修正某個奇怪的東西
  CS	[CS] 修正 Coding Style
  Feature	[Feature] 寫了某個新功能
  Update	[Update] 改了某個文字檔
  Refactor	[Refactor] 重構了某個功能

  當 PR 有相對應的 issue 號碼時，建議加在 PR 類型後面，舉例如下

  PR 標題範例
  [Feature #90] 寫了某個新功能
  [BugFix #119] 修正某個壞掉的功能

• PR comment
  有相關的 issue 時在 comment 內列出
  範例如下：

  PR comment 範例
  修正 #123
  Fixed #123 #107
  完成 #123 #90
  Finish #123 #90
  Finish #123 merge after #90
  完成 #123 在 #90 之後 merge

• close issue
  關閉 issue 時請填寫關閉的理由
  幾種關閉的理由列舉如下

  close issue comment example
  closed by #123
  該 issue 已有結論
  該 issue 已結案

• commit message (建議寫法，不強制規定)
  有相關的 issue 時在 commit message 內列出
  commit message 的格式如下

  commit message balabalba (issue #123)
  

  主要的規則是在原本的 commit message 後加上括號，括號內填寫 issue 的編號

  範例如下：

  commit message 範例
  Do something well (fixed #107)
  fixed the bug of the category counts (issue #123)
  complete feature balabala (for #123)
  complete feature balabala. for #123

  可自動關閉 issue 的語法統整
  fix #xxx
  fixes #xxx
  fixed #xxx
  close #xxx
  closes #xxx
  resolve #xxx
  resolves #xxx
  resolved #xxx

[ Bug ] script 的 mod_rewrite 沒有打開

as title.