在第三方平台中為 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 會在您的專案中自動使用這些規則做為內容。