contributing
1.0.0
首先，Ideoxan開發人員團隊要親自感謝您抽出寶貴的時間為我們的項目和社區做出貢獻！
本文檔包含所有必要的信息，以促進IDEOXAN項目。如有任何疑問，請通過[email protected]與我們聯繫。
該項目根據該項目的官方行為準則進行維護和管轄。同意其條款和條件，以及Ideoxan的官方服務條款，IDEOXAN的隱私政策和隨附的許可證（MIT），需要為該組織的項目做出貢獻。
運行後端服務器需要Node.js運行時（這是為網站服務的方法）。支持10.x以上的版本。建議使用節點13.x也需要NPM，但通常使用node.js安裝。您可以通過執行來檢查Node.js版本
node -vGit CLI必須從存儲庫中下載代碼。
支持JS ES6規格的現代瀏覽器必須查看網站Chrome/Chromium，Firefox和Safari的網站。
雖然MongoDB不是100％運行該網站的需要，但我們建議您無論如何都可以安裝它，以便可以使用登錄和用戶驗證。要安裝MongoDB，請參閱其文檔指南。確保服務器在localhost或環境變量的本地或系統列表中指定的其他位置運行
使用以下內容下載存儲庫並安裝所需的軟件包：
git clone https://github.com/ideoxan/ideoxan.git
cd ideoxan
npm install服務器支持使用整個系統和本地環境變量。如果您無法設置整個系統範圍的環境變量，請在主IDEOXAN目錄中創建.env文件。確保您的節點環境未設置為production ，否則環境變量將不會在本地使用。以下是二手環境變量的列表。如果他們中的任何一個矛盾，請告知我們。
MONGO_URI
EXPRESS_SESSION_SECRET
PWD_HASH MONGO_URI環境變量用於設置MongoDB數據庫的URI。該URI必須是有效的蒙古語字符串。默認值為mongodb://localhost:27017/ix
EXPRESS_SESSION_SECRET環境變量是該服務器使用的所有會話都將使用的秘密。最好保持這種安全和安全，因為可以用來無效，修改和欺騙會議（這不好）。保持盡可能長的時間。由於安全原因，沒有默認值。
PWD_HASH環境變量是一個整數值，用於在BCRYPTJS模塊中放置密碼。在密碼安全的地方保持足夠高的數字，但足夠低，以至於不會導致服務器放慢速度。同樣，出於安全原因，沒有默認值。
如果您想為課程或課程做出貢獻，請參閱我們的其他github庫，其中包括curriculum-的前綴。我們所有的課程指南都保存在GitHub上（並非全部可公開），並且在/static/curriculum下存儲了服務，並由客戶端要求在靜態Express Directory（ /static ）下。編輯，網站或其任何內容不包括課程。在git下，這些課程作為子模型包括在內，可以通過以下內容安裝在課程目錄下：
git submodule init
git submodule update --recursive這將克隆，獲取並拉動所有公開可用的課程。如果您想進一步了解Git子模型以及它們如何工作，請單擊此處。
使用了兩個主要分支： master and prod 。 prod分支是發送和部署的產品。我們嘗試僅在需要時每隔一段時間更新該分支（較慢的修補程序可以合併）。 master分支是我們大多數新承諾所去的地方。將其視為一個新鮮的每晚建造系統。儘管該分支擁有最新的代碼，但這並不意味著它是最穩定的。如果您計劃長期使用它，並且不想每20分鐘更新一次，我們建議您使用prod分支。
運行服務器有三個選項。
開發人員模式是在開發計算機上運行服務器的命令。這允許輕鬆編輯和快速的服務器啟動。它依賴於Nodemon軟件包，因此請確保通過NPM安裝了package.json中概述的開發人員依賴項。
在本地運行服務器：
npm run dev要啟動服務器而沒有任何其他功能，請運行：
npm run start這會自動更新任何隨附的子模塊，然後啟動服務器。或者，可以像任何普通的node.js項目一樣啟動服務器：
node server.js不建議使用此方法，因為此選項是針對Ideoxan使用的特定服務器的個人量身定制的。
這需要在全球安裝PM2。
npm run server如果那不起作用，則使用：
pm2 start server.js --name ideoxan --max-memory-restart 500M --watch --cron " 0 2 * * * " 首先，如果您認為這個問題是與安全有關的問題，請不要打開問題。通過電子郵件直接向我們報告錯誤
您要報告的問題通常是一個安全問題。
如果您經歷了上述任何一種，這很可能是可能的安全風險的結果，應報告。未報告可能會代表我們提出法律行動。
即使您的問題不符合上述問題，並且仍然認為這是與安全有關的問題，也不要猶豫發送電子郵件。最好是安全而不是對不起。
請檢查以下內容，以確保您被清除以打開問題。
如果您的問題與node.js運行時有關，即iDeoxan或其他任何內容的任何軟件包/軟件，那麼這不是提交問題的合適地方。如果您需要針對適當的錯誤跟踪器或故障排除指南的幫助，請隨時與我們聯繫。 （請聯繫我們）
如果您修改了任何來源，則該問題的可能性很高，這是由篡改引起的。如果此問題在恢復您的代碼後仍然存在，請打開問題。
我們不支持舊軟件。請檢查您的版本package-lock.json以在master Branch的package.json中指定的版本。
如果該問題已經報告，並且在我們的GitHub上仍在打開，請評論您的問題，而不是打開新問題。如果仍未打開，請檢查其狀態。如果它在問題上附帶了wont-fix標籤，請不要再次提出它，除非您將其視為一個突出的問題，並且已經經過了很大的時間。還要檢查是否有解決方案。有時，問題會被關閉，不是因為它們被標記為無效或解決方案，而是因為缺乏活動。如果您覺得是這種情況，請隨時要求重新開放該問題。
如果您與安全性有關，請參閱報告安全問題。
如果您遵循上述要求並滿足要求，現在可以打開一個問題。確保使用描述性標題，並清楚地描述您的問題。確保遵循錯誤報告模板（強烈建議）。如果您未能正確描述問題，您的問題將在沒有解釋的情況下關閉。
如果您為代碼庫做出貢獻（不包括文檔），請確保遵循我們的標準。
請檢查是否已經有任何問題可以解決。如果不是，請確保拉動請求尚未涵蓋您試圖合併的內容。
如果您確定上述內容，請使用我們的PR模板打開拉動請求
如果您建議IDEOXAN添加新功能或在現有功能上擴展，請使用功能請求模板打開問題
即將推出
如果您有不滿足上述問題的問題或疑慮，請隨時與我們聯繫（請參閱與我們聯繫）
該存儲庫旨在允許兼容性，統一性和整體知名度。我們建議您如果嘗試為該項目的來源做出貢獻，則您會閱讀以下內容。
即將推出
| 標籤 | 描述 | 搜尋 |
|---|---|---|
| 關鍵錯誤 | 一個完全妨礙網站的錯誤，對基本操作/管理至關重要 | ？ |
| 蟲（媒介） | 一個中等嚴重性的錯誤會影響站點和/或其用戶的很大一部分。 | ？ |
| 錯誤（低） | 一個低優先級錯誤，幾乎不會影響網站和/或其用戶 | ？ |
| 標籤 | 描述 | 搜尋 |
|---|---|---|
| 複製 | 問題是以前的，封閉（已解決的）問題，打開（待處理）問題或封閉請求請求的副本 | ？ |
| 不會修復 | 與該項目無關的問題或無法解決的問題 | ？ |
| 無效的 | 一個不受項目流行或無法複製的問題 | ？ |
| 問題 | 必須提供更多信息，以使問題有效 | ？ |
| 標籤 | 描述 | 搜尋 |
|---|---|---|
| 網站 | 與網站有關的問題 | ？ |
| 伺服器 | 與服務器相關的問題 | ？ |
| 文件 | 與網站，服務器或API的文檔有關的問題 | ？ |
| 其他 | 不涉及網站，服務器或文檔的問題 | ？ |
| 增強 | 關於正在考慮的新功能或已存在的新功能的建議 | ？ |
| 標籤 | 描述 | 搜尋 |
|---|---|---|
| 把招工廣告 | 給出需要外部審查或貢獻的問題或拉的請求的標籤。通常，如果給出的話，問題要么不取決於維護者的知識範圍，要么不是最高優先級。 | ？ |
| 好的第一個問題 | 如果您在這裡是新手，那麼這是一個不錯的起點！這要么是一個積極的問題，要么是新移民解決問題的一個很好的例子。 | ？ |
如果您需要伸出援手，請通過以下以下鏈接與我們聯繫
將來將添加更多平台。
