-
Notifications
You must be signed in to change notification settings - Fork 0
JSON comments for automation ‐ Experimental
This document describes an experimental effort to describe backbone issues in a structured way with as little ambiguity as possible. The structure of the json comments is very likely to change. If you want describe your backbone-feedback using one of the structures here, feel free. Also feel free to ignore the comment altogether.
We are starting to describe simple changes using json. See some examples below. Not all issues are possible to describe in a clear way and some are too complex to describe or it unclear what the right solution is.
A github action script could then be written to periodically (after a backbone build), to scan the issues to see if the changes have been applied.
FYI these json descriptions are only for describing the problem in an structured clear way, and do not have any effect on what actual gets changed in the backbone.
The GBIF backbone is usually only updated 1 or 2 times per year. Therefore, issues that are fixed at source can often remain unchanged in the backbone for many months. Also there can be complexities in the backbone building process (such as checklist priority or COL updates), which means a given source might not make into a new build even though it was updated.
Below are some working examples (subject to change) of ways to capture various backbone issues in a succinct, structured way. These are not meant to be a full description of the problem, but give just enough information to check if it has been fixed.
If multiple proposed changes are found in one issue, one can use a json array.
// json for auto-checking
{
"currentName": "Paradohertya triphasia Bethune-Baker, 1904",
"proposedName": "Paradohertya trifascia Bethune-Baker, 1904"
}Name should not exist at all.
// json for auto-checking
{
"badName": ""
}Name should exist
// json for auto-checking
{
"missingName": ""
}// json for auto-checking
{
"name": "Alphocoris spec Linnavuori, 1984",
"wrongRank": "KINGDOM",
"rightRank": null
}// json for auto-checking
{
"name": "Alphocoris spec Linnavuori, 1984",
"wrongGroup": "Plumbaginaceae",
"rightGroup": null
}Still working on some good tags for synonym related issues. Will put some ideas here.
// json for auto-checking
{
"name": "",
"wrongParent": null,
"rightParent" : null,
"wrongStatus": "SYNONYM",
"rightStatus": "ACCEPTED"
}