Skip to content

Revise comments and documentation (grouped) #307

Description

@somethingwithproof

Group: Comments and documentation

Revise all comments and documentation to be unambiguous, logical, grammatically correct, and spell-checked.

Scope

  • PHP file comments (block headers, inline, docblocks)
  • README.md, CHANGELOG.md, CONTRIBUTING.md, CLAUDE.md, CactiCheatSheet.md
  • .github templates (bug_report, feature_request)
  • Translatable strings in __() calls (typos affect translations)
  • Fix aggergated to aggregated in mactrack_utilities.php (lines 454, 489)

Standards

  • Unambiguous: avoid vague terms; use precise technical language
  • Logical: structure and flow make sense; no contradictions
  • Grammar: correct punctuation, subject-verb agreement, tense consistency
  • Spelling: fix typos

Related

Activity

  1. somethingwithproof commented on Mar 9, 2026

    @somethingwithproof
    MemberAuthor

    Dotfile updates committed (3fbe8b0):

    • .gitignore: Cacti copyright 2004-2026, locales/po/*.mo
    • .github: copyright in bug_report, feature_request; PR wording fix
    • .cursor/rules: change-verification with updated branch examples
    • TDD section added to project rules
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions