chore: Example style guide

Open
#90 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
css, typescript
Domain
design, documentation, frontend

Research direction

The issue names no files or tests. Start by reviewing the existing Examples and their current styling and dependencies, then document the stated conventions and propose a reusable shared stylesheet. Done means the written style guide and the shared styling proposal are both complete.

Written by the indexing model from the issue text.

Description

type:docs

Create a "style guide" for Examples. The goal of this should be to help keep examples on target and any complication should be around the problem at hand. e.g.

  • Minimal external dependencies, prefer none/web platform packages over 3rd party dependencies
  • Pure CSS
  • No UI libraries
  • No Typescript
  • Related examples should have similar things (e.g. fetch and Apollo fetching examples should be the same site with only the client changed)
  • Lots of comments explaining what and why
  • etc...

Tasks

  • create the written "style guide" for examples
  • research and propose a shared styling system that can be reused across examples (e.g. a stylesheet that can be copied and pasted)
Dominant language
PHP
Stars
47
Forks
3
Avg merge
1m
Merged PRs (30d)
19

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wpengine/hwptoolkit

All issues in wpengine/hwptoolkit

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.