https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/Recent content in Coding Standards on BWRGYHugoen-ushttps://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/css/Mon, 01 Jan 0001 00:00:00 +0000https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/css/<h2 id="formatting--naming">Formatting &amp; Naming</h2> <ul> <li>Use 2 spaces for indentation</li> <li>One selector per line in multi-selector rules</li> <li>Use kebab-case for class names: <code>.main-header</code>, <code>.btn-primary</code></li> <li>Prefix component classes: <code>.card-title</code>, <code>.nav-item</code></li> <li>Use meaningful, descriptive names over abbreviated ones</li> </ul> <h2 id="organization--structure">Organization &amp; Structure</h2> <ul> <li>Group related properties together (positioning, box model, typography, visual)</li> <li>Use comments to separate major sections</li> <li>Keep specificity low - avoid deep nesting</li> <li>Mobile-first approach with min-width media queries</li> <li>Separate layout, components, and utility classes</li> </ul> <h2 id="best-practices--tools">Best Practices &amp; Tools</h2> <ul> <li>Avoid <code>!important</code> - use higher specificity instead</li> <li>Use CSS custom properties for repeated values</li> <li>Prefer classes over IDs for styling</li> <li>Use Prettier for consistent formatting</li> <li>Lint with stylelint for error checking</li> </ul> <h2 id="references">References</h2> <ul> <li><a href="https://css-tricks.com/guides/">CSS-Tricks</a></li> <li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">MDN Web Docs – CSS</a></li> <li><a href="https://www.smashingmagazine.com/tag/css/">Smashing Magazine – CSS</a></li> </ul>https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/docsy/Mon, 01 Jan 0001 00:00:00 +0000https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/docsy/<h2 id="formatting--structure">Formatting &amp; Structure</h2> <ul> <li>Use TOML frontmatter for all content files</li> <li>Follow Hugo&rsquo;s content organization with <code>_index.md</code> for sections</li> <li>Use consistent weight values for navigation ordering</li> <li>Keep markdown files clean with proper heading hierarchy</li> <li>Use Hugo shortcodes for complex content blocks</li> </ul> <h2 id="content--navigation">Content &amp; Navigation</h2> <ul> <li>Include proper frontmatter: <code>title</code>, <code>description</code>, <code>type</code>, <code>weight</code></li> <li>Use descriptive page titles and meta descriptions</li> <li>Organize content in logical directory structures</li> <li>Set up proper menu navigation with parent-child relationships</li> <li>Use <code>no_list: true</code> to exclude pages from section listings</li> </ul> <h2 id="best-practices--tools">Best Practices &amp; Tools</h2> <ul> <li>Test responsive design across different screen sizes</li> <li>Validate Hugo build process with <code>hugo --gc --minify</code></li> <li>Use Hugo&rsquo;s built-in syntax highlighting for code blocks</li> <li>Implement proper search functionality with Docsy&rsquo;s search features</li> <li>Follow accessibility guidelines for documentation sites</li> </ul> <h2 id="references">References</h2> <ul> <li><a href="https://www.docsy.dev/docs/">Docsy theme documentation</a></li> <li><a href="https://gohugo.io/content-management/">Hugo content management</a></li> </ul>https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/html/Mon, 01 Jan 0001 00:00:00 +0000https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/html/https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/javascript/Mon, 01 Jan 0001 00:00:00 +0000https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/javascript/https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/php/Mon, 01 Jan 0001 00:00:00 +0000https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/php/https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/wordpress/Mon, 01 Jan 0001 00:00:00 +0000https://handbook-bwrgy-org-971173.gitlab.io/handbook/development/coding-standards/wordpress/<h2 id="formatting--naming">Formatting &amp; Naming</h2> <ul> <li>Follow WordPress PHP coding standards (tabs for indentation)</li> <li>Use snake_case for function names: <code>get_custom_post_data()</code></li> <li>Prefix all functions, classes, and globals with unique identifier</li> <li>Use descriptive hook names: <code>my_plugin_before_content_display</code></li> <li>Follow WordPress file naming conventions</li> </ul> <h2 id="hooks--functions">Hooks &amp; Functions</h2> <ul> <li>Use proper WordPress hooks instead of direct file modifications</li> <li>Sanitize and validate all user input</li> <li>Escape output data with appropriate functions: <code>esc_html()</code>, <code>esc_attr()</code></li> <li>Use WordPress functions over PHP equivalents when available</li> <li>Check user capabilities before executing admin functions</li> </ul> <h2 id="best-practices--tools">Best Practices &amp; Tools</h2> <ul> <li>Use WordPress coding standards with PHPCS</li> <li>Follow the WordPress Plugin/Theme directory guidelines</li> <li>Implement proper nonce verification for forms</li> <li>Use WordPress transients for caching</li> <li>Test with WordPress debug mode enabled</li> </ul> <h2 id="references">References</h2> <ul> <li><a href="https://developer.wordpress.org/coding-standards/wordpress-coding-standards/">WordPress coding standards</a></li> <li><a href="https://developer.wordpress.org/themes/basics/">Theme development guidelines</a></li> <li><a href="https://developer.wordpress.org/themes/functionality/security/">Theme security and validation</a></li> </ul>