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

Use example formatting in placeholders. Labels++ #198

Merged

Conversation

GeoMaciolek
Copy link
Contributor

Update labels w/descriptions, instead of placeholder fields. This includes:

Changes

CamelCase / CapNames for Models

e.g. Person not person, LibraryBook not library_book or librarybook

This is the norm, per:

app_name with underscores

This is the norm in general as well, examples provided if needed!

attribute_names with underscores

e.g. first_name not firstname etc. - all I did here was make the placeholder a bit more obvious. Examples also provided on request.

Reasoning

The placeholder text amodel led me to create a project with models like audio_file and author instead of AudioFile and Author. In theory I should have known better, but, I let my GUI-brain treat the hints literally. Whoops! I figured I wouldn't be the only person who ended up having to do a bunch of ultimately unneccesary refactoring and find/replace work, so, here's what should hopefully help!

Update labels w/descriptions, instead of placeholder fields.
src/schemas.js Outdated Show resolved Hide resolved
src/schemas.js Outdated Show resolved Hide resolved
Copy link
Contributor Author

@GeoMaciolek GeoMaciolek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed! I've added a commit.

@mmcardle mmcardle merged commit 8bd6545 into mmcardle:master Jul 29, 2023
4 checks passed
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

Successfully merging this pull request may close these issues.

2 participants