LearnNewsExamplesServices
Frontmatter
id7889
titleUpdate Coding Guidelines for JSDoc and Refactor GitHub Workflow MCP
stateClosed
labels
documentationenhancementai
assigneestobiu
createdAtNov 24, 2025, 10:10 AM
updatedAtNov 24, 2025, 10:40 AM
githubUrlhttps://github.com/neomjs/neo/issues/7889
authortobiu
commentsCount0
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtNov 24, 2025, 10:40 AM

Update Coding Guidelines for JSDoc and Refactor GitHub Workflow MCP

Closed v11.10.0 documentationenhancementai
tobiu
tobiu commented on Nov 24, 2025, 10:10 AM

The current coding guidelines regarding JSDoc comments for class methods are insufficiently detailed, leading to inconsistencies in the codebase.

Goals:

  1. Update .github/CODING_GUIDELINES.md:

    • Explicitly forbid empty lines between the method description and the first @param tag.
    • Mandate descriptions for all @param tags.
    • Mandate "Block Formatting" for parameters: vertically align types, parameter names, and descriptions.
    • Standardize on not using hyphens (-) to separate parameter names from descriptions.
  2. Refactor ai/mcp/server/github-workflow:

    • Apply these new rules to all services in ai/mcp/server/github-workflow/services/.
tobiu added the documentation label on Nov 24, 2025, 10:10 AM
tobiu added the enhancement label on Nov 24, 2025, 10:10 AM
tobiu added the ai label on Nov 24, 2025, 10:10 AM
tobiu assigned to @tobiu on Nov 24, 2025, 10:10 AM
tobiu referenced in commit f4d7e9c - "Update Coding Guidelines for JSDoc and Refactor GitHub Workflow MCP #7889" on Nov 24, 2025, 10:40 AM
tobiu closed this issue on Nov 24, 2025, 10:40 AM