only droids
This commit is contained in:
17
.factory/rules/project.md
Normal file
17
.factory/rules/project.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Project Rules
|
||||
|
||||
Do not put obvious comments in the code. Every comment should add value to the codebase.
|
||||
Docstrings are different than comments.
|
||||
Do not put emojis in the code. Use ASCII characters as much as possible.
|
||||
|
||||
## Explore
|
||||
|
||||
Always start with `tree --gitignore`. Do not get stuck in loop of running `ls` or `grep`.
|
||||
|
||||
Try to understand the code structure first.
|
||||
Try to grab the coding style and patterns used in the codebase. It will help you to write code that is consistent with the existing codebase.
|
||||
|
||||
## Motive
|
||||
|
||||
The motive should to do things the right way and not the easy way. The right way is to follow the coding standards and best practices.
|
||||
The easy way is to write code that is quick and not manageable. Avoid the easy way.
|
||||
Reference in New Issue
Block a user