-
Notifications
You must be signed in to change notification settings - Fork 3
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
Create kpi-backend-development.md #10
base: main
Are you sure you want to change the base?
Conversation
Attempting to document kpi backend, like we have for frontend.
@@ -0,0 +1,29 @@ | |||
--- | |||
title: KPI Backend Development |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jnm, pull from various sources (zulip, github issue, etc.) to flesh this out.
Probably remove the break early thing? It's likely more of a judgment call than a rule.
Add guidance for assertNumQueries()
: set it to fail, read the queries printed out, understand them and ask questions if necessary, and if the queries then are okay, set the count. Investigate the use of ranges for these assertions. Discuss fixtures so that list-type queries return enough objects that bad query-per-each-result patterns are obvious.
Make sure your unit tests can fail!!!
etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jnm should we merge this as is and try to improve it as we go?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do_the_thing() | ||
``` | ||
|
||
- Avoid unnecessary Django migrations. New pull requestions should contain no more than 1 migration, unless necessary. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"pull requestions" should be "pull requests"?
Attempting to document kpi backend, like we have for frontend.