Add Plugin Framework conventions documentation #32

New issue

Closed

opened 2026-06-14 18:18:50 +00:00 by ldraney · 0 comments

ldraney commented 2026-06-14 18:18:50 +00:00

Owner

Copy link

Type

Feature

Summary

Add docs/conventions.md capturing audit findings from comparing our provider against HashiCorp scaffolding, terraform-plugin-framework, and OpenTofu.

User Story

As a provider developer, I want a conventions reference so I can follow best practices without re-auditing the upstream repos.

Context

Audit performed 2026-06-14 against three upstream repos cloned locally.

Lineage

Parent: none
Story: dns-iac

Repo

godaddy-tofu

Scope

• docs/conventions.md with provider setup, resource patterns, error handling, HTTP client, acceptance test structure, build automation
• README docs table update

File Targets

• docs/conventions.md (new)
• README.md (table update)

Feature Flag

None

Test Expectations

Docs only — no code changes

Acceptance Criteria

• Conventions doc covers all audit findings
• README links to it

Constraints

None

Checklist

• Doc created
• README updated

Related

Informs: #31, #13

### Type Feature ### Summary Add `docs/conventions.md` capturing audit findings from comparing our provider against HashiCorp scaffolding, terraform-plugin-framework, and OpenTofu. ### User Story As a provider developer, I want a conventions reference so I can follow best practices without re-auditing the upstream repos. ### Context Audit performed 2026-06-14 against three upstream repos cloned locally. ### Lineage Parent: none Story: dns-iac ### Repo godaddy-tofu ### Scope - `docs/conventions.md` with provider setup, resource patterns, error handling, HTTP client, acceptance test structure, build automation - README docs table update ### File Targets - `docs/conventions.md` (new) - `README.md` (table update) ### Feature Flag None ### Test Expectations Docs only — no code changes ### Acceptance Criteria - [ ] Conventions doc covers all audit findings - [ ] README links to it ### Constraints None ### Checklist - [ ] Doc created - [ ] README updated ### Related Informs: #31, #13

ldraney referenced this issue from a pull request that will close it, 2026-06-14 18:19:01 +00:00

Add Plugin Framework conventions doc #33

ldraney referenced this issue from a pull request that will close it, 2026-06-14 18:20:25 +00:00

Add Plugin Framework conventions doc #33

ldraney closed this issue 2026-06-14 18:45:06 +00:00

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

docs/keycloak-public-ingress

No results found.

Labels

Clear labels

No items

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

ldraney/godaddy-tofu#32

No description provided.