貢獻(xiàn)給 CodeIgniter

2020-08-19 10:42 更新

CodeIgniter 是一個(gè)大眾驅(qū)動(dòng)項(xiàng)目并且它接受自大眾提供的編碼和文檔編制貢獻(xiàn)。這些貢獻(xiàn)將在 Github 的 CodeIgniter4 repository 上以討論的形式或者以 Pull Requests 形式產(chǎn)生。

討論是指出一個(gè)程序錯(cuò)誤最快捷的方式。如果你在 Codeigniter 中找到了程序錯(cuò)誤或者文檔編制錯(cuò)誤,請(qǐng)首先檢查一些要事:

  • 是否存在一個(gè)已經(jīng)開(kāi)放的討論。
  • 討論已經(jīng)被解決了。(檢查開(kāi)發(fā)分支,或者查看關(guān)閉的討論。)
  • 你明確的確實(shí)要獨(dú)自解決問(wèn)題嗎?

發(fā)布討論是有幫助而且發(fā)出 Pull Request 是一個(gè)更好的方式,PR 是基于 “Forking” 主要的內(nèi)容并提交到你自己拷貝版本里。

請(qǐng)查看代碼庫(kù)的 貢獻(xiàn)給 CodeIgniter4 章節(jié)。

支持

請(qǐng)記住 GitHub 決不支持一般使用性的問(wèn)題!如果將來(lái)你在使用 Codeigniter 中有了困難,請(qǐng)去網(wǎng)絡(luò)論壇尋求幫助代替發(fā)表在 forums 上。

如果你不能保證你使用中出現(xiàn)的事情是否正確或者你又發(fā)現(xiàn)了一處程序錯(cuò)誤,請(qǐng)首先在網(wǎng)絡(luò)論壇中詢問(wèn)。

安全性

你已經(jīng)在 CodeIgniter 中找到一個(gè)安全問(wèn)題了嗎?

請(qǐng)不要公開(kāi)揭露你發(fā)現(xiàn)的安全問(wèn)題,但是你要發(fā)送郵件給 security@codeigniter.com,或者經(jīng)由我們 HackerOne 的頁(yè)面發(fā)布它。 如果你已經(jīng)找到了一個(gè)瀕臨崩潰的安全危險(xiǎn),我們很高興把你的發(fā)現(xiàn)放在我們的 ChangeLog 里。

優(yōu)良的討論報(bào)告貼士

使用有描述的主題原則(例如 parser library chokes on commas)好于含糊不清的主題(例如 your code broke )。

在報(bào)告里計(jì)算機(jī)物理地址是單獨(dú)說(shuō)明的問(wèn)題。

識(shí)別清楚 codeigniter 的版本(例如 3.0 - develop)和你知道的組件(例如 parser library)

闡述你預(yù)期將要發(fā)生的事或者已經(jīng)發(fā)生的事。包括任何錯(cuò)誤的信息和堆棧軌跡。

如果代碼程序段能夠幫助說(shuō)明要把短代碼程序段考慮在內(nèi)。使用 pastebin 或者 dropbox 很容易提取更長(zhǎng)的代碼程序段或者截圖 ———— 截圖并不包含討論報(bào)告自身。 本段文字的主旨是設(shè)定問(wèn)題解決的合理終結(jié),直到問(wèn)題解決或者關(guān)閉。

如果你知道如何解決討論,你要在你自己的 fork & branch 做好解決方案,并且提交堆棧請(qǐng)求(pull request)。 上文中的問(wèn)題報(bào)告信息應(yīng)當(dāng)是整個(gè)報(bào)告的一部分。

如果你的討論報(bào)告描述能分步驟的再現(xiàn)問(wèn)題,那是極好的。如果你在再現(xiàn)問(wèn)題時(shí)能把單元測(cè)試考慮在內(nèi),那將更好,討論報(bào)告要給任何正在解決問(wèn)題的人一個(gè)更加清楚的目標(biāo)!

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)