docs: Add CONTRIBUTING.md and improve developer documentation#190
Open
Nepomuceno wants to merge 4 commits into
Open
docs: Add CONTRIBUTING.md and improve developer documentation#190Nepomuceno wants to merge 4 commits into
Nepomuceno wants to merge 4 commits into
Conversation
- Create comprehensive CONTRIBUTING.md explaining: - Prerequisites (Go, Terraform, Make, tflint) - Project structure and source vs generated files - How code generation works with diagram - Step-by-step guide for adding new Azure resources - Field reference for resourceDefinition.json - Running locally (Make and PowerShell) - PR guidelines and checklist - Update README.md with Development section: - Brief explanation of code generation process - File overview table showing editable vs generated files - Quick start commands - Link to CONTRIBUTING.md for details Related: #174, #177 Closes #184
Nepomuceno
force-pushed
the
docs/add-contributing-guidelines
branch
from
d20824e to
f823f62
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive contributor documentation to improve the developer experience for the terraform-azurerm-naming module. It replaces fragmented documentation with structured guides explaining the code generation architecture.
Key Changes:
- Created detailed CONTRIBUTING.md with step-by-step instructions for adding Azure resources
- Restructured README.md with improved "Development" section explaining code generation flow
- Added visual diagrams showing how JSON definitions transform into Terraform files
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
New comprehensive guide covering prerequisites, project structure, code generation workflow, resource addition steps, and PR guidelines |
README.md |
Replaced "Internals" section with structured "Development" section including code generation flow diagram, file overview table, and links to detailed CONTRIBUTING.md |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
CONTRIBUTING.md (new file)
resourceDefinition.jsonREADME.md (updated)
Related Issues
Notes
main.tf,outputs.tf)