indieweb/wordpress-indieweb

Developer instructions for h-card and rel-me inclusion into themes

Open

#90 opened on Dec 6, 2017

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)PHP (18 forks)github user discovery
help wanted

Repository metrics

Stars
 (84 stars)
PR merge metrics
 (Avg merge 8h 39m) (1 merged PR in 30d)

Description

Based on conversations here: https://chat.indieweb.org/wordpress/2017-12-04#t1512409227038500 (and cross reference https://chat.indieweb.org/wordpress/2017-12-04#t1512409462787400)

We should better document and include an example for how to include the h-card output into a theme. Ideally it could be done to the level that a Gen2 person could reasonably follow to add it, perhaps by cutting and pasting a code segment.

There's apparently similar code for for rel-me, so that should be documented too.

Contributor guide

Research direction
Examine the plugin's code for h card and rel me output functions, then write clear documentation with example code snippets for theme integration.
Tech stack
php
Domain
full stack
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
WordPressPHPGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70