Switch camelCase to snake_case in schema conventions doc #129
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vcschapp
requested review from
DavidKarlas,
jwass,
jenningsanderson,
TristanDiet-TomTom and
danabauer
jenningsanderson
previously approved these changes
Feb 23, 2024
SCHEMA_CONVENTIONS.md
Outdated
| @@ -4,7 +4,7 @@ | |||
| 2. [GeoJSON](https://geojson.org/) is used as a canonical geospatial format | |||
| i.e. GeoJSON provides us a mental model and language to express data constructions, without being the data format in which the Overture data is published | |||
| ## Schema notation conventions | |||
| - camelCase is used for all property names as described in the [Google JSON Style Guide](https://google.github.io/styleguide/jsoncstyleguide.xml) | |||
| - `snake_case` is used for all property names, string enumeration members, and string-valued enumeration equivalents | |||
| - boolean properties have a prefix verb "is" or "has" in a way that grammatically makes sense | |||
| e.g. | |||
| hasStreetLights=true | |||
There was a problem hiding this comment.
let's snake_case this example as well
There was a problem hiding this comment.
Ohhh man. Thanks.
jwass
previously approved these changes
Feb 23, 2024
TristanDiet-TomTom
previously approved these changes
Feb 26, 2024
vcschapp
dismissed stale reviews from TristanDiet-TomTom, jwass, and jenningsanderson
via
0444bd3
vcschapp
force-pushed
the
snake_case_convention
branch
from
5990324
to
0444bd3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Brief description of the business purpose and effect of the pull request.
Following up on PR #127, this PR makes a change that was missed in the previous one, updating the schema conventions document to bring it in line with the new
snake_caseconvention.Reference
List of relevant links to GitHub issues, PRs, and other documentation.
Testing
Brief description of the testing done for this change showing why you are confident it works as expected and does not introduce regressions. Provide sample output data where appropriate.
N/A - Just a markdown documentation change.
Checklist
Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.
Documentation Website
Update the hyperlink below to put the pull request number in.
Docs preview for this PR.