diff options
Diffstat (limited to 'schemas/config/readme.md')
| -rw-r--r-- | schemas/config/readme.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/schemas/config/readme.md b/schemas/config/readme.md new file mode 100644 index 00000000..e59a7469 --- /dev/null +++ b/schemas/config/readme.md @@ -0,0 +1,13 @@ +# Config file schemas + +These schemas describe RoadRunner configuration file and used by: + +- <https://github.com/SchemaStore/schemastore> + +Schemas naming agreement: `<version_major>.<version_minor>.schema.json`. + +## Contributing guide + +If you want to modify the existing schema - your changes **MUST** be backward compatible. If your changes break backward compatibility - you **MUST** create a new schema file with a fresh version and "register" it in a [schemas catalog][schemas_catalog]. + +[schemas_catalog]:https://github.com/SchemaStore/schemastore/blob/master/src/api/json/catalog.json |