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

Reminder - Improving project onboarding code #7

Open
Danajoyluck opened this issue Jul 23, 2024 · 1 comment
Open

Reminder - Improving project onboarding code #7

Danajoyluck opened this issue Jul 23, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@Danajoyluck
Copy link
Contributor

Need to improve the onboarding code per PR review feedback from @david-a-wheeler . The code needs optimization. This issue serves as a reminder.

@david-a-wheeler
Copy link

Great! Just to clarify my JSON comment, since the generated files do not meet the JSON specification, it's confusing & will cause tool problems.

I think the simplest solution is to rename ".json" to ".json5", and where you insert comments, use JSON5's line comment marker "//", like this:

// This is a comment

Sometimes JSON isn't quite enough, and since all you want is JSON with comments, JSON5 should suit you perfectly & require VERY little effort of you. While JSON is used more than JSON5, JSON5 has significant support (e.g., it has built-in support in vim). More about the JSON5 format is here: https://json5.org/

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

No branches or pull requests

2 participants