First, thank you for your interest in helping to bring reliable, flexible structured data to WordPress!
Schemify aims to bring structured data to WordPress, by automatically building JSON-LD objects that conform to Schema.org specifications. Schemify sets reasonable defaults that serve the majority of users, while enabling developers to control the data being used to represent their content.
Schemify has two major branches: develop and master. The develop branch represents the features currently in-progress, while master corresponds to the latest release. For a good explanation of this pattern, please see the 10up Engineering Best Practices.
When starting a new feature branch, please be sure to branch off of develop; the only time anything is merged into master is during a release.
Eventually, it would be great if Schemify could represent every available Schema. To aid in this process, the SchemaInheritanceTest class uses official (albeit experimental) JSON representations of Schema definitions and compares them to the class structure of the plugin.
As these tests require additional downloads (stored in tests/data/), they are not run by default. If you're introducing a new Schema to Schemify, please run the following tests:
$ phpunit --group=schemaDefinitionsThese tests accomplish two things:
- Verifying the inheritance tree (e.g. ensuring that "Article" extends "CreativeWork", which in-turn extends "Thing").
- Analyze the properties used by each Schema to ensure they match the specification.
The first time you run these tests, the test suite will take much longer than usual as a side-effect of downloading the individual Schema definitions. Fortunately, these results will be cached for 90 days, so subsequent runs will be much faster.
Schemify strives to provide a high level of useful tests for each corresponding schema, using the WordPress core test framework If your contributions are updating any code, please include appropriate tests!
In order to ensure a clean upgrade path for users, Schemify adheres to semantic versioning and maintains a change log according to the Keep a Changelog standards.
When submitting a pull request, please add a new change log entry under the "Unreleased" heading.