File tree Expand file tree Collapse file tree 1 file changed +3
-3
lines changed
Expand file tree Collapse file tree 1 file changed +3
-3
lines changed Original file line number Diff line number Diff line change 22 - before start a task, try to find if there are related items in backlogs. Read them to know the current status about the project.
33 - if no related items found, plan your action and create the plan in backlogs/. Read the README.md file in the project folder.
44 - An item in backlogs/ should have 2 sections:
5- 1. the overview, the plan, the todo list.
5+ 1. the overview, the plan, the todo list. (no need to put development setup details)
66 2. summarization of what has been done.
77 - after a task is done, update the backlog and README.md/DEV.md in the project folder. (automation_api/README.md / automation_api/DEV.md)
88 - breaking changes are fine, we don't need to keep backward compatibility.
2323# Code Quality
2424- We use pre-commit hooks for code quality checks
2525 - Run `pre-commit install` to set up the hooks (only needed for new env)
26- - Hooks will run automatically on git commit
27- - You can also run manually with `pre-commit run --all-files`
26+ - Hooks will run automatically on git commit. (So you don't need to run it manually)
27+ - You can also run manually with `pre-commit run --all-files`.
2828- use snake_case for variable names
2929- use all uppercase for constants
3030- prefer functional programming style
You can’t perform that action at this time.
0 commit comments