Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Outline #1

Open
3 of 35 tasks
fleeting opened this issue May 13, 2020 · 0 comments
Open
3 of 35 tasks

Initial Outline #1

fleeting opened this issue May 13, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@fleeting
Copy link
Member

fleeting commented May 13, 2020

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.
@fleeting fleeting added the documentation Improvements or additions to documentation label May 13, 2020
@fleeting fleeting self-assigned this May 13, 2020
fleeting added a commit that referenced this issue May 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant