This piece of documentation explains how to contribute to the list of jargons available for comparison in the Dialect map UI.
To be able to contribute to the project public datasets, collaborators would need to fork this repository into their personal accounts. Those forks will be the ones being modified before proposing changes to the upstream copy of the datasets.
To fork this repository, please click this link.
These are all the operations that community contributors can perform.
When defining a new jargon group, or a new jargon term, the new JSON object must have a unique ID within the file.
- For the jargon group objects:
group-<group-position>. - For the jargon terms objects:
group-<group-position>-jargon-<jargon-position>.
In addition, contributors must set the archived field as false, for the object to be properly stored.
When removing an existing object, contributors must change its archived property to true.
This operation is called soft deletion.
Implementing an archival procedure allow the data files to preserve all the jargon groups and jargon terms that were ever defined. This preservation is very useful for several reasons:
- It helps contributors know the sequential ID they must specify on new created objects.
- It eases the automatic differentiation of JSON objects inside arrays (very hard otherwise).
Modification of existing objects is not supported. If a relevant typo, or something semantically incorrect in the definition of jargon groups is discovered, please:
- Archive the invalid object.
- Define a new one with the error corrected.
Once a given change has been approved, and its corresponding Pull Request (PR) merged, the new objects will be propagated to the database. For more information, check the computing documentation.