Skip to content

Initial Outline #1

@fleeting

Description

@fleeting

Putting together an initial outline of what we should cover in our best practices. Some of this we already have but isn't documented and the rest we will flesh out.

  • Markup/HTML

    • Accessibility: our standards, testing, resources, etc.
    • Structure: readability, schema.org, js classes, polyfills/featured detection etc.
    • Media: images, audio, video, and embeds.
    • SVG: optimizing, animating, making accessible, sprites (vs icon font), etc.
    • Fonts: optimizing, limitations, fallbacks, etc.
  • CSS

    • Accessibility: reduced motion, etc.
    • Responsive: breakpoints and media query placement.
    • Syntax/Formatting: formatting, declaration ordering, nesting, specificity, and naming.
    • Documentation: commenting, reusable, etc.
  • JavaScript

    • Design Patterns:
    • Performance: libraries, event delegation, caching, animation, etc.
    • Code Style:
    • Testing:
    • Libraries: components, frameworks, etc.
  • PHP

    • Performance: database queries, caching, data storage, etc.
    • Design Patterns: namespacing, patterns, structure, etc.
    • Security: validation, sanitization, nonces, internationalization, etc.
    • Code Style:
    • Testing:
    • Libraries: frameworks, etc.
  • Version Control

    • Repos: naming pattern, readme files, wiki, etc.
    • Workflows: commit messages, branches, merging, archiving, etc.
  • Tools

    • Local Environments: Local, Docker, Vagrant, etc.
    • Scaffolding: generators, etc.
    • Task Runners: gulp, webpack, etc.
    • Package Manager: composer, npm, yarn, etc.
    • Command Line: WP-CLI, etc.
    • Accessibility: screen readers, browser extensions, apps, etc.
    • Browser/Device Testing: saucelabs, etc.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions