coentrify.json
One file at the root of a project says how the project uses coentrify.
- The File - what it holds
- States - how a project follows a standard
- Versions - how a change is found
- The Check - what keeps the file true
The File
The onboarding writes coentrify.json, and the director changes it after.
{
"source": "https://github.com/coentrify/coentrify",
"version": "0.0.1",
"folders": { "docs": "docs", "standards": "standards" },
"workflow": "simple",
"records": ["changelog", "healing-log"],
"wiki": "vitepress",
"healing": "automatic",
"modules": {
"behavior": {
"always-make-no-mistakes": "tracked",
"understand-the-need": "customized"
}
}
}source- the repository the standards came from, so a version of coentrify of your own works the same wayversion- the version of coentrify the project is atfolders- where the docs and the standards liveworkflow,records,wiki- the choices from the onboardingworkflowissimpleorticketsrecordslists each record kept by its place underdocs/records/:log,activity,changelog,healing-log,playtests,user-testsmodules- every standard taken from coentrify, by module, with its statehealing- who makes a harness change:automaticby default, where a subagent makes it, logs it in the healing log and the report names it for a veto, orreview, where it is filed for the directorcontributor- left out by default. Set totrue, the project may file changes at the source.filing- for a contributor:reviewby default, where the director looks at an issue before it is filed at the source, orautomatic, where the subagent files it on its ownlibraries- left out by default. Each library the project contributes to, by name, with itssourceand afilingof its own, as above (Library Feedback)
A module whose standards come from somewhere else can carry a source of its own.
States
tracked- an update replaces the filecustomized- an update reports the changes
A tracked standard that is changed by hand becomes customized. So does a standard whose update the director declines. The reason goes in standards/decisions.md.
A standard the project wrote itself is not listed. It goes in the module it belongs to, beside the standards from coentrify, so the links and the index keep working. A subject coentrify does not cover yet, such as React, gets a module of its own.
Versions
Coentrify has one version, and a project is at one version. The changelog names every standard that a version changed.
A standard the changelog does not name needs no attention.
The Check
A check built from its spec in the tools keeps the file true.
- A folder the file names has to exist.
- A standard the file lists has to be on disk.
- A state is
trackedorcustomized. healingandfilingareautomaticorreview, andfilingstands only besidecontributor: true.
With --staged, as a pre-commit step, the check also refuses a commit that changes a tracked standard by hand. The commit passes once the state is customized, or when the commit changes the version, as an update does.