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

Comment our config order to provide documentation #10

Open
jdsteinbach opened this issue Apr 20, 2018 · 3 comments
Open

Comment our config order to provide documentation #10

jdsteinbach opened this issue Apr 20, 2018 · 3 comments

Comments

@jdsteinbach
Copy link
Contributor

It'd be great to comment each block of properties in the config: giving each group a title/description will provide context & justification for the order. It'll also help onboard new team members more sensibly. It'll help all of us save time discussing sorting ideas in the future by recording the logic behind our past decisions.

@jsit
Copy link
Contributor

jsit commented Apr 22, 2018

Unfortunately I don't think json allows comments :c

@eshtadc
Copy link
Contributor

eshtadc commented Jul 13, 2018

While JSON itself doesn't allow comments, this file is JSON data within a js file so you should be able to comment it.

@eshtadc
Copy link
Contributor

eshtadc commented Jul 13, 2018

Also - given that the code just exports a giant structure, we could generate that structure in parts in order to make it more readable and then just export the final object at the end.

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

3 participants