Skip to content

Conversation

@httpdss
Copy link
Owner

@httpdss httpdss commented Dec 16, 2024

Overview

This PR refactors the syntax and structure across various modules and updates associated documentation files. It also reorganizes certain YAML configurations for improved maintainability and readability.

Changes

  • Syntax Updates:
    • Standardized struct values across modules:
      • Replaced terraform-module with terraform/module.
      • Updated folder struct labels (e.g., go-project to project/go).
  • Documentation Updates:
    • Revised examples in README.md and README.es.md to reflect updated struct labels.
    • Improved consistency in code examples and descriptions.
  • Configuration File Updates:
    • Moved .github/workflows files into dedicated subfolders.
    • Added missing configurations like release-drafter.yaml.
    • Removed redundant or unused YAML files.
  • Renaming for Consistency:
    • Renamed project contribution files (e.g., go-project.yaml to project/go.yaml) for logical categorization.

Justification

This update ensures that the project adheres to a standardized naming convention, improving clarity and consistency across the codebase. It also simplifies future maintenance and onboarding for contributors.

Impact

  • Positive:
    • Reduces confusion caused by inconsistent syntax and naming.
    • Enhances readability of both code and documentation.
    • Lays a foundation for streamlined automation workflows.
  • Potential Issues:
    • May require contributors to adjust their local configurations to align with the new structure.

@httpdss httpdss changed the title Refactor folder structure references from 'terraform-module' to 'terraform/module' and update related documentation Standardize Struct Syntax and Update Documentation Dec 19, 2024
@httpdss httpdss marked this pull request as ready for review December 19, 2024 12:06
@httpdss httpdss merged commit 1dae975 into main Dec 19, 2024
2 of 4 checks passed
@httpdss httpdss deleted the naming-restructure branch December 19, 2024 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants