| Status | CategoryBlueprintNew (do not edit if already approved in Launchpad) |
| Launchpad Entry | pg-builtin-consistencycheck |
| Modules affected | None |
| Responsible | Please enter a responsible person (responsible=xxx) |
Contents
Summary
This should provide an overview of the issue/functionality/change proposed here. Focus here on what will actually be DONE, summarising that so that other people don't have to read the whole spec.
A new playground builtin to check if branches in the file system are the same as in projects.py. Playground should always check this and report inconsistencies to the user. There should also be a way of establishing consistency again. Either this is done within this builtin command or within an own command. Both commands should be exposed to the user through the CLI.
Release Note
This section should include a paragraph describing the end-user impact of this change.
Rationale
This should cover the _why_: why is this change being proposed, what justifies it, where we see this justified.
Use Cases
Assumptions
Design
You can have subsections that better describe specific parts of the issue.
Implementation
This section should describe a plan of action (the "how") to implement the changes discussed. Could include subsections like:
API Changes
Should cover changes required to the API, or specific API that is required to implement this
Code Changes
Code changes should include an overview of what needs to change, and in some cases even the specific details.
Migration
Include:
changes in configuration files
backward compatibility if API changes
how users will be pointed to the new way of doing things, if necessary.
Test/Demo Plan
It's important that we are able to test new features, and demonstrate them to users. Use this section to describe a short plan that anybody can follow that demonstrates the feature is working.
This need not be added or completed until the specification is nearing beta.
Open Issues
This should highlight any issues that should be addressed in further specifications, and not problems with the specification itself; since any specification with problems cannot be approved.
BoF agenda and discussion
Use this section to take notes during the BoF 1; if you keep it in the approved spec, use it for summarising what was discussed and note any options that were rejected.
The acronym is used by the Internet Engineering Task Force (IETF) to denote initial meetings of members interested in a particular issue (1)