@@ -9,12 +9,9 @@ This is a Python app for managing recipes.
99- Simple
1010- Thoughtful UI/UX
1111- Minimal JavaScript
12-
13- We prefer server-side render pages.
14-
15- We focus on exporting and importing data to several formats.
16-
17- Aesthetics is important, but even more important is usability.
12+ - We prefer server-side render pages.
13+ - We focus on exporting and importing data to several formats.
14+ - Aesthetics is important, but even more important is usability.
1815
1916## Tech Stack
2017
@@ -33,21 +30,23 @@ Aesthetics is important, but even more important is usability.
3330
3431## Coding conventions
3532
36- - Try to keep code readable and maintainable
37- - Apply the DRY principle as much as possible (but not more)
38- - When a file approaches 1000 lines, split it up into sub modules
33+ - Try to keep code readable, maintainable and testable.
34+ - Apply the DRY principle as much as possible (but not more).
35+ - When a file approaches 1000 lines, split it up into sub modules.
3936- When a function approaches 60 lines or indentation levels greater than
40- 4 or 5, consider splitting the function into several
37+ 4 or 5, consider splitting the function into several.
4138
4239## Development
4340
44- Issues are in ` issues/ ` . When you are told to solve one issue, delete
45- the issue file and commit your changes with git.
46-
47- When commiting, supply author information on the command line. Try to
48- explain the "why" behind the changes. The "what" can be read from the
49- diff, even though a short itemized summary to reflect intent can't hurt.
50-
51- When adding new features, document them in ` docs/ ` .
52-
53- When modifying models, check whether it makes sense to update the ` seed_db.py ` .
41+ - Issues are in ` issues/ ` . When you are told to solve one issue, delete
42+ the issue file and commit your changes with git.
43+ - When commiting, supply author information on the command line. Try to
44+ explain the "why" behind the changes. The "what" can be read from the
45+ diff, even though a short itemized summary to reflect intent can't
46+ hurt.
47+ - Run ` uv run python src/plated/manage.py test recipes ` before
48+ comitting.
49+ - When adding new features, document them in ` docs/ ` . Add Django test
50+ cases.
51+ - When modifying models, check whether it makes sense to update the
52+ ` seed_db.py ` .
0 commit comments