raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-03-04 02:31:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add note about query services (https://github.com/openfoodfoundation/openfoodnetwork/pull/12203)

David Cook
2024-03-04 10:08:34 +11:00
parent 754295b4b4
commit 6a3e2c3dd2
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Code-Conventions.md

@@ -2,6 +2,13 @@ Firstly, code conventions are enforced by Rubocop, in order to improve code cons
This pages lists additional conventions that are not verified by Rubocop, but we agree to follow.
# Ruby/Rails
Use existing code convention patterns where appropriate. Including:
## Queries
Please adhere to the naming convention when introducing new query-related services in the `app/queries` folder. This consistency will streamline code readability and maintain a clear understanding of the purpose of each service.
# Database Migrations
See this guide: [[Database-migrations]]
@@ -80,4 +87,4 @@ TODO: how to avoid this
##### Example 1
Using has_many declarations in serializers is one of the most common causes of N+1 queries in code.
TODO: how to avoid this
TODO: how to avoid this