17 lines
2.0 KiB
Markdown
17 lines
2.0 KiB
Markdown
# Agent Guide
|
|
|
|
Also see the other related technical documentation in the docs folder.
|
|
|
|
## Rules
|
|
|
|
- This is a Windows environment, WSL is not installed (i.e. sed is not available). You're running under PowerShell 7.5.4. Due to platform restrictions, file deletions are not possible. Replacing the entire file content via a context diff is a viable alternative.
|
|
- PowerShell doesn't support bash-style heredocs. If complex scripts need to be executed, consider using python as a last resort. Run Python code using python -c with inline commands instead of python - <<'PY'.
|
|
- If you find unexpected changes in the code (deletions, changes, diff results that were not communicated), never revert them and never restore the old state. Assume that those changes happened with intent.
|
|
- Never use reset commands or equivalent rollback actions to discard local changes unless the user explicitly asks for that exact rollback. Assume that uncommunicated file changes are a possibility between each interaction with the user.
|
|
- Prefer extracting code to a shared helper to be reused instead of duplicating code. Always keep high maintainability standards.
|
|
- Keep changes as small as possible, design solutions that achieve the goals with minimal churn.
|
|
- Always place each newly created class into its own file. The file name must match the class name.
|
|
- When asked to begin working on a task, create a detailed implementation plan first, present the plan to the user, and ask for approval before beginning with the actual implementation.
|
|
- When an task is finished, perform a code review to evaluate if the change is clean and maintainable with high software engineering standards. Iterate on the code and repeat the review process until satisfied.
|
|
- After the implementation is finished, verify all changed files, and run `python D:\Code\crlf.py $file1 $file2 ...` only for files you recognize, in order to normalize all line endings of all touched files to CRLF.
|
|
- At the end perform a git commit with a one-liner summary. |