Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the data model and testing workflow #538

Open
tordans opened this issue Aug 16, 2018 · 2 comments
Open

Document the data model and testing workflow #538

tordans opened this issue Aug 16, 2018 · 2 comments

Comments

@tordans
Copy link
Contributor

tordans commented Aug 16, 2018

To make it easier to contribute …

a. it would be great to have a documentation of the data model for the json.

Eg the "required:true" attribute is interesting, what does it "do" / how are clients supposed to use/interpret it?

b. it would be great to have a documentation about how to test a PR.

Eg is the only way to test this to create a local iD Editor instance and run it against a local copy? How would I do this? Or is there maybe a version of iD Editor that allows testing of manually pasted JSON files?

Thanks

Update:

@bhousel
Copy link
Member

bhousel commented Aug 26, 2018

a. it would be great to have a documentation of the data model for the json.

The JSON-Schema doc https://github.com/osmlab/editor-layer-index/blob/gh-pages/schema.json is both the data model and the documentation.

@tordans
Copy link
Contributor Author

tordans commented Oct 1, 2018

Fore Reference: #562

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants