diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index edbab63..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "yaml.schemas": { - "schema.json": "frequency-plans.yml", - "end-device/schema.json": "end-device/*.yml", - "end-device/modifiers/schema.json": "end-device/modifiers/*.yml", - "gateway/schema.json": "gateway/*.yml", - "gateway/modifiers/schema.json": "gateway/modifiers/*.yml" - } -} diff --git a/README.md b/README.md index 0401fa3..9380d28 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,19 @@ Thank you for your interest in building this thing together with us. We're reall The Things Stack uses the `github.com/TheThingsNetwork/lorawan-frequency-plans` as default source for fetching frequency plans. Therefore, contributing to this open source repository makes frequency plans automatically available to Stack deployments with default settings. You can contribute by submitting pull requests. Are you new to GitHub? That's great! [Read here about pull requests](https://help.github.com/articles/about-pull-requests/). Please also use the editor settings as defined in `.editorconfig`. +There are json schemas available for all configuration files. These define files structure and make it easier to fill them in. To enable them in `VSCode` add the following to your `settings.json` file. +```json +{ + "yaml.schemas": { + "schema.json": "frequency-plans.yml", + "end-device/schema.json": "end-device/*.yml", + "end-device/modifiers/schema.json": "end-device/modifiers/*.yml", + "gateway/schema.json": "gateway/*.yml", + "gateway/modifiers/schema.json": "gateway/modifiers/*.yml" + } +} +``` + ### Local Regulations When submitting a new frequency plan or making changes to an existing frequency plan, please make sure that the band is allowed to be used in the concerning region and that settings respect regional regulations. When submitting a pull request for a new region, please upload or link to a document that describes the local regulations.