The-DevOps-Daily/terraform-provider-validatefx

Document validator architecture overview

Open

#109 opened on Oct 29, 2025

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Go (25 forks)github user discovery
documentationgood first issuehacktoberfest

Repository metrics

Stars
 (21 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Write a high-level architecture document describing how validators, Terraform functions, and integration tests connect.

Content suggestions:

  • Outline the flow from internal/validators to internal/functions.
  • Highlight extension points and coding conventions for new contributors.
  • Link to relevant files and examples for quick onboarding.

Contributor guide

Research direction
Study the codebase structure: examine `internal/validators` and `internal/functions` directories. Identify how validators are defined and how they are used by Terraform functions. Look at existing integration tests to understand the test flow. Then write a high level architecture document that explains the flow, extension points, and coding conventions. Link to relevant files and examples.
Tech stack
go
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGoTerraform
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80