Skip to content

refactor: cleanup files - #12

Merged
victormgomes merged 1 commit into
mainfrom
refactor/replace-comments-with-self-documenting-code
Jul 29, 2026
Merged

refactor: cleanup files#12
victormgomes merged 1 commit into
mainfrom
refactor/replace-comments-with-self-documenting-code

Conversation

@victormgomes

Copy link
Copy Markdown
Owner

Description

Refactor the codebase to replace explanatory comments with self-documenting code
through better naming, extracted methods, and type-safe constructs. Also translates
all Portuguese log messages and descriptions to English.

Type of change

  • 💥 Breaking change (fix or feature that would cause existing functionality
    to not work as expected)

Checklist

  • My code follows the style guidelines of this project (I have run
    composer run format).
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation (e.g. README.md).
  • I have added tests that prove my fix is effective or that my feature
    works.
  • New and existing tests pass locally with my changes (I have run
    composer run test).
  • My code does not lower the test coverage metrics (I have run
    composer run test-coverage).
  • I have run architectural quality checks and resolved major issues (I have
    run composer run insights).
    Note: The Security parameter in the #[AsyncApi] attribute kept its name and is just a PHPDoc addition, but renaming $action from string to the new Action enum could break users who pass a raw string 'send' instead of Action::Send. Hence the breaking change category. If you don't consider that breaking, move it to a regular refactor.

@victormgomes
victormgomes merged commit cb6cd68 into main Jul 29, 2026
34 checks passed
@victormgomes
victormgomes deleted the refactor/replace-comments-with-self-documenting-code branch July 29, 2026 08:55
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 2.0.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant