メニュー
Use when creating PRs, writing or editing documentation (schema descriptions, docs markdown, examples), creating or restructuring examples/, reviewing code, or adding changelog entries.
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。
npx skills add https://github.com/mongodb/terraform-provider-mongodbatlas --skill pr-and-documentation-standardsコマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。
ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。
Use when creating a brand-new autogenerated (serviceapi) resource in this provider from an OpenAPI spec — "autogenerate new terraform resource <name>", a new-resource workflow dispatch, or any request to add a new autogen resource together with its acceptance tests, examples, docs, and changelog.
Use when updating an existing autogenerated (serviceapi) resource for API spec changes — typically surfaced by the "Updates auto-generated production resources (DO NOT MERGE)" bot PR or a scheduled regeneration diff, or when asked to incorporate a spec change, add a new attribute to a serviceapi resource, or follow up on an autogen visibility PR.
Best practices for writing and organizing acceptance tests in this Terraform provider. Use when creating new acceptance tests, modifying existing tests, fixing flaky tests, or reviewing test code. Covers test consolidation, avoiding duplicates, plural data source ordering, and plan-only validation tests.
SOC 職業分類に基づく
SKILL.md を表示中
| name | pr-and-documentation-standards |
| description | Use when creating PRs, writing or editing documentation (schema descriptions, docs markdown, examples), creating or restructuring examples/, reviewing code, or adding changelog entries. |
PR titles must follow Conventional Commits: fix:, feat:, chore:, doc:, test:, refactor:, ci:, etc. The subject after the colon must start with an uppercase letter.
fix: Emit warning when use_effective_fields and auto-scaling are enabled
feat: Add search deployment resource
Do not include a scope in parentheses (e.g. fix(resource/mongodbatlas_advanced_cluster): ...). The repo convention uses the bare prefix without a scope.
Avoid mixing refactoring with functional changes in the same PR. Reviewers need to clearly distinguish which changed lines are behavioral vs structural.
Add a changelog entry (.changelog/<PR_NUMBER>.txt) for:
release-note:bug)release-note:enhancement)release-note:breaking-change)release-note:new-resource / release-note:new-data-source)Emits, Adds, Fixes, Updates)Avoid excessive NOTE/IMPORTANT/WARNING boxes. Prefer:
Do not include CLOUDP ticket references in user-facing documentation. Internal ticket references are acceptable in code comments only when tracking a deliberate technical decision.
Start data source and resource descriptions with the resource name and a clear one-line purpose:
`mongodbatlas_log_integration` provides a resource for managing log integration configurations at the project level.
examples/ directory)The following rules are the default for new provider examples. One user journey (flow) stays a flat root with the files listed under Flat vs siblings. Two or more flows use sibling directories. Copy examples/mongodbatlas_cloud_backup_collection_restore_job/ for that layout. Read example-layout.md in this skill directory for the canonical tree, Atlas project comment, common mistakes, and exceptions.
examples/mongodbatlas_<name>/ (main.tf, variables.tf, providers.tf, versions.tf, README.md).README.md (index only, no parent main.tf) plus sibling directories named for what they do.snapshot_restore, pit_restore). Do not use generic singular-data-source.tf / plural-data-source.tf.terraform_remote_state. Document cross-example flow in the grouped README; users copy outputs into terraform.tfvars..tf file starts with a one- or two-sentence comment stating the goal. Match the sibling README opening line (the first sentence after the H1, not the H1 itself).README.md lists siblings, typical flows, and links to the product doc. Collection restore links to Restore from Selected Databases and Collections. Other resources link their own product page.variable with a description. Put defaults in variables.tf and document them in the README.job_state, collection_states, discovery IDs). Place output blocks in the primary .tf file or the Terraform file for the surface they describe. Use a dedicated outputs.tf only when it makes the example easier to read. Each output has a description.templates/**/*.md.tmpl. Embed with tffile pointing at a real file under examples/, for example {{ tffile "examples/mongodbatlas_cloud_backup_collection_restore_job/snapshot_restore/main.tf" }}. Further Examples links point at sibling directories.State once, not per sibling:
provider "mongodbatlas" {}. Credentials come from the environment, not from HCL. Do not set client_id, client_secret, public_key, or private_key on the provider.export examples use Service Account MONGODB_ATLAS_CLIENT_ID / MONGODB_ATLAS_CLIENT_SECRET. Prefer those. Programmatic API keys via env also work.versions.tf sets source = "mongodb/mongodbatlas" and required_version only.New examples use providers.tf. Leave existing provider.tf names alone.