developer-code-organization

Featured

Code organization patterns, file structure guidelines, WASM build variants, and string processing conventions for gh-aw Go code.

Code & Development 5,125 stars 539 forks Updated today MIT

Install

View on GitHub

Quality Score: 90/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Code Organization Use this reference for gh-aw code organization patterns, file structure guidelines, WASM build-variant stubs, and string sanitization/normalization conventions. ## Table of Contents - [File Organization Principles](#file-organization-principles) - [Excellent Patterns to Follow](#excellent-patterns-to-follow) - [File Size Guidelines](#file-size-guidelines) - [Decision Trees](#decision-tree-creating-new-files) - [Case Study: Refactoring Large Files](#case-study-refactoring-large-files) - [Anti-Patterns to Avoid](#anti-patterns-to-avoid) - [Helper File Conventions](#helper-file-conventions) - [String Sanitization vs Normalization](#string-sanitization-vs-normalization) - [WASM Build-Variant Pattern](#wasm-build-variant-pattern) ### File Organization Principles The codebase follows clear patterns for organizing code by functionality rather than type. This section provides guidance on maintaining code quality and structure. #### Prefer Many Small Files Over Large Ones Organize code into focused files of 100-500 lines rather than creating large monolithic files. **Example:** ``` create_issue.go (160 lines) create_pull_request.go (238 lines) create_discussion.go (118 lines) ``` #### Group by Functionality, Not by Type **Recommended approach:** ``` create_issue.go # Issue creation logic create_issue_test.go # Issue creation tests add_comment.go # Comment addition logic add_comment_test.go # Comment tests ``` **Avoid:*...

Details

Author
github
Repository
github/gh-aw
Created
1 years ago
Last Updated
today
Language
Go
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category