翻譯原文: Developer FAQ

關於提交與審查的問題

提交審查外掛會需要花多少時間?

這沒有一個官方平均的時間。就像沒有外掛是完全一樣的。如果你的外掛不大,且程式碼運作正常,那應該七天內審查會通過,不過如果外掛中有一些程式問題的部分需要改進,就看你修正的時間。不論何種結果,你都會得到一封來自 plugins AT wordpress.org 的通知信。所以請將這信箱加入到你的信箱白名單,然後有耐心的等待我們的回覆吧!

如果外掛發生問題,我有多少時間可以提出修正?

自我們連絡你關於外掛發生的問題後算起,希望於七天內解決問題。這是唯一讓我們等待佇列保持低量的作法。如果你需要超過七天的時間,我們將會先拒絕你的提交,待完成修正後重新提交即可。

有沒有什麼特別的事是我需要避免發生的?

我們會關注較明顯的事項,那些都被列在我們的開發手冊中,大部分都可以總結一句「不要成為一個廣告發送者。」以下簡述較常發生的部分:

  • 忘了包含 readme.txt 外掛描述檔

此檔案是用在外掛型錄展示中關於外掛的重要檔案,裡頭將解釋外掛如何呈現、如何使用等資訊。

  • 沒有在外掛開發中使用 WP_DEBUG 模式測試過。

我們會在 WP_DEBUG 模式下測試你的外掛,而你也應該再提交前如此這麼做,如果外掛無法正常作用,我們將會退件。

  • 引用客製化版本 JavaScript 套件

WordPress 結合許多套件於一身(包含 jQuery),所以我們請你使用內建的,不要自帶。

  • 呼叫額外檔案

所有的外掛都應該盡可能是自成一體,如果你的外掛是需要依靠其他服務的情況下(像是 Twitter),那呼叫遠端的JS執行沒問題。但如果你試圖將圖片和JS放置於CDN上不提供服務,我們是禁止的。

  • "Powered By" 連結

外掛提供的連結資源在網站前端顯示中必須為選項。這表示你的外掛不能預設將網站連回你的網站,或者是網站中被訪客看到的一個部分。

  • 資訊採集

這不只是追蹤用戶還包含傳送資料回你的主機(像是使用 iframe),除非這就是你外掛必須這麼處理的部分,即使如此,我們也會請你解釋。

我可以修改我的外掛名稱嗎?

答案是也不是,你可以修改顯示名稱,但 slug 登記網址顯示名稱不行。所以,如果你提交了一款 My cool tool 為外掛名,那這外掛的 URL 路徑就將會是 https://tw.wordpress.org/plugins/my-cool-tool/ 而且也會是使用者安裝外掛時的外掛目錄名稱。

有沒有什麼外掛名稱是不被允許的?

我們不允許 WordPressplugin 字眼被使用在外掛名稱上,因為這已經很明顯是一款 WordPress 外掛。名稱僅接受使用英文字母與阿拉伯數字在 slug 上!所以不能使用像是中文或阿拉伯符號在 URL 上,而且為了相容性問題,我們也不允許版本數字出現在外掛名稱中。

除非你代表官方提交該外掛,不然也不鼓勵使用線上服務、平台、工具或函式庫名稱命名,特別是如果外掛正是與此類有關的情形。發揮你的創造力,建立你獨一無二的外掛名子吧!

如果我已經有一個外掛了,但我想重做他,是不是重新提交比較好呢?

我們比較建議是改寫現有的外掛,讓他用主線版本釋出。我們無法改外掛名,所以新的那個將無法轉換任何現存使用者、評分、支援主題、評分、下載數以及加入我的最愛等資訊。

關於你的程式碼倉庫問題

我該在哪個目錄放置外掛檔案呢?

將外掛檔案放置在程式碼倉庫的 trunk 目錄下,釋出新版本時使用 tag 標記並複製到對應版本號的 tags 目錄下。記得更新 trunk/readme.txt 檔案中新穩定版標籤。

螢幕快照檔案較理想的做法應該是放置在 assets 目錄中(有可能需要手動建立在 svn 程式碼倉庫的根目錄下),目錄與 tagstrunk 同層。取代以往螢幕快照檔案放置於各 tag 版本以及主線 trunk 的目錄上,減少被打包時的 ZIP 檔案大小。查看更多特色發佈可前往此則發文

我不能在 trunk 中建立子目錄放外掛檔案嗎?

你可以,但是不是個好做法。 WordPress.org 會自動打包所有在 trunk 中的檔案為 ZIP 檔,所以沒有必要放置你的外掛檔案在子目錄中。如果你的外掛很複雜,擁有相當多檔案,那你當然可以透過子目錄來分類好檔案,但 readme.txt 檔案與主外掛檔必須要放置在 trunk 目錄中。

我該如何命名 tags 標籤(或是釋出版本)?

你的 Subversion tags 標籤應該要看起來像是版本號。尤其是他們應該只能包含數字跟小數點。 2.8.4 就是一個好的 tag 標籤,而 my neato releaso 就是不太好的例子。簡單處理又無害對吧?你答對囉!注意,這邊是指 Subversion tags 標籤,不是 readme.txt 的標籤,那裡的設定可以隨你喜好而改。

我可以指定哪個版本才是給 WordPress.org 用戶使用的嗎?

可以,透過設定在你 trunk 目錄下 readme.txt 檔案中的 Stable Tag 欄位就可以囉。

WordPress.org 從哪裡抓到外掛的資料?

從主外掛檔案、readme.txt 檔案和 Subversion 程式碼倉庫中取得。作者(Author)欄位、版本(Version)欄位、標籤(Tags)欄位、外掛名稱(Plugin Name)欄位、作者與外掛網站(Author URI、Plugin URI)欄位、建立時間(Creation time)欄位,與上次更新時間欄位。

我對程式碼倉庫提交了一些改變,要多久才能在 WordPress.org 線上看到最新的更新?

WordPress.org 外掛每幾分鐘更新一次,不過更新花費時間取決於外掛更新佇列大小。

我能在外掛中引用 SVN externals 嗎?

不行,抱歉。你可以新增 SVN externals 在你的程式碼倉庫,但他不會被加入到可下載的 ZIP 檔案中。

要如何在外掛展示頁中加入很酷的橫幅圖示呢?

首先在程式碼倉庫中建立 assets 資料夾(與 trunk 同層級),放置你的橫幅圖示於其中,並且命名為 banner-772x250.pngbanner-772x250.jpg ,影像必須剛好 772 像素寬與 250 像素高,不接受 GIF 檔。

若要支援高DPI影像(像是 retina )顯示,你可以增加一個 banner-1544x500.pngbanner-1544x500.jpg 檔案,影像必須剛好 1544 像素寬與 500 像素高,不接受 GIF 檔。

這個檔案只會在網站偵測到瀏覽器正處於高 DPI 情況下展示,可閱讀此則發布消息以獲得更多資訊。在你提交確認過新的的橫幅圖示後,這將會花幾分鐘於下次外掛頁面刷新時顯示。對於開發與測試,你可以在外掛頁面加上 ?banner_url=你的圖檔網址 參數預覽顯示結果。這功能只適用你的外掛,對其他外掛無效。

後記

這份 FAQ 還要搭配開發導引手冊一起看比較詳細,我個人就是採到了外掛命名的雷(不能出現品牌名稱),所以送了兩次才過,除此之外都滿詳細了。

- Powered by Mxp.TW -FB2WP-

Facebook 外掛功能


Share:

作者: Chun

資訊愛好人士。主張「人人都該為了偷懶而進步」。期許自己成為斜槓到變進度條 100% 的年輕人。[//////////____30%_________]

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *