third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-04-18 17:47:38 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

schemas/README: Per-schema README is now mandatory

Browse Source 
I think I only made this 'SHOULD' before because at that stage I'd not yet
written the README files for the legacy schemas.
This commit is contained in:
Athanasius 2022-09-02 13:38:53 +01:00
parent 2eb213d766
commit 08127d261f
No known key found for this signature in database
GPG Key ID: 8C392035DD80FD62
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
schemas/README-EDDN-schemas.md
View File

@ -15,7 +15,7 @@ those actually running on the Live service.
The Schema files themselves are considered to be the canonical definition of
the required, and allowed, contents of the relevant EDDN message. There
**SHOULD** be an accompanying README file, e.g. for `commodity-v3.0.json` there
**MUST** be an accompanying README file, e.g. for `commodity-v3.0.json` there
is also a `commodity-README.md` file in the project root `schemas/` directory.
For more general documentation that all developers wanting to either Upload