Skip to content

[REFACTOR] refactor: overhaul documentation, git staging logic, and i18n templates #67

@thomas-vilte

Description

@thomas-vilte

Context

I identified a need to modernize the project's documentation to reflect a more personal and cohesive tone across both English and Spanish guides. Additionally, the internal git staging logic required improvements to handle file states more robustly, and the internationalization (i18n) templates contained syntax errors that caused rendering issues during error scenarios.

Technical Details

  • Rewrote README.md, COMMANDS.md, and CONTRIBUTING.md (and their Spanish counterparts) to improve clarity and tone.
  • Updated internal/git/git_service.go to use the -A flag in git add, ensuring all file changes (including deletions) are staged correctly.
  • Corrected i18n TOML templates in active.en.toml and active.es.toml, replacing invalid {0} placeholders with Go template syntax {{.Error}}.
  • Refactored internal/commands/handler/suggestions.go to pass structured error maps to the template engine.
  • Removed obsolete GoReleaser configuration files (.goreleaser.yml and workflows) to clean up infrastructure.

Impact

  • Users now have access to more engaging and accurate documentation.
  • The CLI handles file staging operations more reliably, reducing potential git errors.
  • Error messages during commit failures now render correctly without template parsing issues.
  • The repository infrastructure is cleaner with the removal of unused release configurations.

Related PR: #59

Metadata

Metadata

Assignees

Labels

docsChanges in documentationfixBug fixesinfraInfrastructure and DevOpsrefactorCode restructuring or cleaning without functional changestech-debt

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions