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

request for a clear and consistent naming convention in CONTRIBUTING.md #143

Open
esskayesss opened this issue Jun 1, 2023 · 0 comments

Comments

@esskayesss
Copy link
Contributor

I would like to request the project maintainers to create a comprehensive CONTRIBUTING.md file that specifies the naming convention for the entities and functions in the codebase. I have come across some instances where it can be confusing and inconsistent to see names like authenticated_user, authorized_user, get_entity and get_entity_model that do not clearly indicate their types or purposes. Issue #115 also points out this problem. I suggest using names that are more descriptive and uniform, clearly indicating their return type.

Even something like get_entity_model and get_entity_dict might be a start. Of course, the final convention may be different and more refined than this, but I believe it would improve the readability and maintainability of the project. Please consider this suggestion. Thank you for your attention and hard work.

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

1 participant