Coding Starter Projects

編碼啟動項目

一個基本存儲庫，可以與他人分享您的入門項目並幫助他們成長！

首先，感謝您抽出寶貴的時間做出貢獻！

鼓勵和重視所有類型的貢獻。請參閱目錄的不同方法，以幫助和詳細說明該項目如何處理它們。在做出貢獻之前，請確保閱讀相關部分。這將使我們的維護人員變得容易得多，並為所有相關人員提供了體驗。社區期待您的貢獻。

而且，如果您喜歡這個項目，但沒有時間做出貢獻，那很好。還有其他簡單的方法來支持該項目並表示感謝，我們也很高興：

• 明星項目
• 鳴叫
• 在您項目的讀數中參考該項目
• 在當地聚會上提及該項目，並告訴您的朋友/同事

目錄

• 行為守則
• 我有一個問題
• 我想貢獻
• 報告錯誤
• 建議增強

行為守則

該項目和參與其中的每個人都受到貢獻。 MD行為守則。通過參加，您應該維護此代碼。請向<>報告不可接受的行為。

我有一個問題

如果您想問一個問題，我們假設您已經閱讀了可用的文檔。

在提出問題之前，最好搜索可能對您有幫助的現有問題。如果您發現了一個合適的問題並且仍然需要澄清，則可以在本期中寫下您的問題。也建議先搜索互聯網以獲取答案。

如果您仍然覺得需要提出問題並需要澄清，我們建議以下內容：

• 打開一個問題。
• 為您遇到的內容提供盡可能多的上下文。
• 根據似乎相關的內容提供項目和平台版本（NODEJS，NPM等）。

然後，我們將盡快解決這個問題。

我想貢獻

法律通知

在為該項目做出貢獻時，您必須同意您已經撰寫了100％的內容，您擁有內容的必要權利，並且可以根據項目許可提供您貢獻的內容。

報告錯誤

提交錯誤報告之前

一個好的錯誤報告不應該讓其他人需要追逐您以獲取更多信息。因此，我們要求您仔細調查，收集信息並詳細描述您的報告中的問題。請提前完成以下步驟，以幫助我們盡快解決任何潛在的錯誤。

• 確保您正在使用最新版本。
• 確定您的錯誤是否真的是一個錯誤，而不是使用不兼容的環境組件/版本（請確保您已經閱讀了文檔。如果您正在尋找支持，則可能需要檢查本節）。
• 要查看其他用戶是否遇到過（可能已經解決）與您遇到的相同問題，請檢查是否尚未在錯誤跟踪器中存在錯誤或錯誤的錯誤報告。
• 另外，請確保搜索Internet（包括堆棧溢出），以查看GitHub社區外的用戶是否討論了該問題。
• 收集有關該錯誤的信息：
• 堆棧跟踪（追溯）
• 操作系統，平台和版本（Windows，Linux，MacOS，X86，ARM）
• 解釋器，編譯器，SDK，運行時環境，軟件包管理器的版本，具體取決於似乎相關的內容。
• 可能是您的輸入和輸出
• 您可以可靠地重現這個問題嗎？您還可以用較舊版本複制它嗎？

如何提交一個好的錯誤報告？

您絕對不能向問題跟踪器或公共場所舉報有關安全問題，漏洞或錯誤，包括敏感信息。相反，敏感的錯誤必須通過電子郵件發送到<>。

我們使用GitHub問題來跟踪錯誤和錯誤。如果您遇到了該項目的問題：

• 打開一個問題。 （由於我們目前無法確定是否是錯誤，我們要求您不要談論錯誤，也不要標記問題。）
• 解釋您期望的行為和實際行為。
• 請提供盡可能多的上下文，並描述別人可以遵循的複製步驟，以自行重新創建問題。這通常包括您的代碼。對於好的錯誤報告，您應該隔離問題並創建減少的測試用例。
• 提供您在上一節中收集的信息。

提交後：

• 項目團隊將相應地標記該問題。
• 團隊成員將嘗試通過您提供的步驟重現問題。如果沒有復制步驟或沒有明顯的方法來複製問題，則團隊將要求您執行這些步驟，並將問題標記為needs-repro 。在復制之前，將不會解決帶有needs-repro標籤的錯誤。
• 如果團隊能夠複製該問題，則將標記為needs-fix以及其他標籤（例如critical ），並且該問題將由某人實施。

建議增強

本節指導您提交有關貢獻的增強建議，包括全新功能和對現有功能的較小改進。遵循這些準則將幫助維護者和社區了解您的建議並找到相關的建議。

提交增強之前

• 確保您正在使用最新版本。
• 仔細閱讀文檔，找出是否已經涵蓋了該功能，也許是通過單個配置。
• 執行搜索以查看是否已經提出了增強。如果有的話，請在現有問題中添加評論，而不是打開新問題。
• 找出您的想法是否適合項目的範圍和目標。您有堅定的理由說服該項目的開發人員此功能的優點。請記住，我們想要對大多數用戶有用的功能，而不僅僅是一個小子集。如果您只是針對少數用戶，請考慮編寫附加/插件庫。

我如何提交良好的增強建議？

增強建議被跟踪為GitHub問題。

• 使用明確的描述性標題來確定該建議。
• 在盡可能多的細節中提供建議增強的逐步描述。
• 描述當前的行為，並說明您期望看到的哪些行為以及原因。在這一點上，您還可以判斷哪種替代方案對您不起作用。
• 您可能需要包括屏幕截圖和動畫GIF ，以幫助您演示該步驟或指出建議與之相關的部分。您可以使用此工具在MacOS和Windows上記錄GIF，以及該工具或Linux上的該工具。
• 解釋為什麼這種增強對大多數貢獻的md用戶很有用。您可能還想指出其他可以更好地解決它並且可以作為靈感的項目。