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

Database naming conventions are not documented #265

Open
2 tasks done
davidvandusen opened this issue Jan 18, 2022 · 0 comments
Open
2 tasks done

Database naming conventions are not documented #265

davidvandusen opened this issue Jan 18, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@davidvandusen
Copy link
Member

davidvandusen commented Jan 18, 2022

Expected behaviour

The README file of the db module explain the naming conventions used for tables, columns, etc., and other conventions.

Actual behaviour

Developers need to intuit the naming conventions from existing schema.

Details and resources

The conventions are based on Ruby on Rails. If they have a web page that explains their conventions, it can be linked to in the README.

It looks like some nice folks have made cheat sheets. For example: https://gist.github.com/iangreenleaf/b206d09c587e8fc6399e

And there is a section in the official docs: https://edgeguides.rubyonrails.org/active_record_basics.html#naming-conventions

Checklist

  • This issue is linked to the appropriate project.
  • This issue has appropriate labels.
@davidvandusen davidvandusen added the documentation Improvements or additions to documentation label Jan 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant