在第三方平台中為 Amazon Q Developer 建立專案規則 - Amazon Q Developer

在第三方平台中為 Amazon Q Developer 建立專案規則

您可以在 GitLab 或 GitHub 中，建置可與 Amazon Q Developer 搭配使用的專案規則庫。這些規則說明整個團隊的編碼標準和最佳實務。例如，您可以有一項規則，指出所有 Python 程式碼都必須使用類型提示，或所有 Java 程式碼都必須使用 Javadoc 註解。將這些規則儲存在專案中，就能確保開發人員的一致性，而不受其經驗程度影響。

專案規則是在專案的 project-root/.amazonq/rules 資料夾內的 Markdown 檔案中定義。

在您建立專案規則後，Amazon Q Developer 會自動使用規則作為專案內的內容，並確保在產生程式碼進行功能開發時遵守這些規則。

若要使用檔案系統建立專案規則

  1. 在您的第三方儲存庫中，開啟專案的根資料夾。

  2. 在專案根資料夾中，建立下列資料夾：

    project-root/.amazonq/rules

    此資料夾會保留您所有的專案規則。

  3. 在 project-root/.amazonq/rules 中，建立專案規則檔案。此檔案必須是 Markdown 檔案。例如：

    cdk-rules.md

  4. 開啟您的專案規則 Markdown 檔案。

  5. 將詳細提示新增至檔案。例如：

    All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled. 
All Amazon SNS topics must have encryption enabled and enforce SSL. 
All Amazon SNS queues must enforce SSL.

  6. 遞交、檢閱及合併您的變更。

  7. (選用) 新增更多專案規則 Markdown 檔案。

    現在您已建立一或多項專案規則。Amazon Q 會在您的專案內自動使用這些規則作為內容。