WordPress / WordPress/php-toolkit

Blueprints JSON versioning

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

Nobody has claimed this yet.

enhancement
Dominant language
PHP
Stars
61
Forks
21
Avg merge
19h 34m
Merged PRs (30d)
7

Description

As the specification becomes more and more developed it may become necessary to change or deprecate the use of certain blueprint keys & values.

If we had a "version" key in the file, similar to docker-compose.yml...

  • We would always be able to tell which version of the spec the file is compatible with.
  • It would be easier to debug & solve issues after keys are changed/deprecated/removed from the spec.
  • It would make it easier for us to provide documentation and support for our users.
  • Supporting multiple versions simultaneously would be possible.
  • Responding to potential security issues would be faster (for example as a last-resort we could ban one version and alias it to a patch)

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

The issue names no files, tests, or entry points. First locate the blueprint parser and specification documentation, then agree on the version key, compatibility rules, and tests needed to demonstrate support; the issue does not define an acceptance target yet.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.