Skip to content

Commit ab07d4a

Browse files
committed
Add agents rule file
1 parent e3a2246 commit ab07d4a

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
description: Agentic rules for code style, comments, and testing.
3+
alwaysApply: true
4+
---
5+
6+
# Project
7+
- All code resides in the `source` directory.
8+
- All tests reside in the `source/Test` directory.
9+
- Follow existing file naming conventions, especially for test files – don't add prefixes or suffixes, keep it clean.
10+
11+
# Code
12+
- Always respect consistency – if the existing code does something differently (before you modified it), stick with that.
13+
- Match existing code style and formatting in the project.
14+
- Prefer shorter, compact code (fewer lines when possible).
15+
- Avoid using of helpers and extensions, especially at a local level – prefer self-sufficient code.
16+
- Avoid using abbreviations for naming, except for absolutely universal words, like `min`, `max`, `html`, etc.
17+
- Place constructors at the top of the type. Do not move or reorder them.
18+
- Code for external frameworks must be compatible with their latest versions.
19+
- Avoid using unnecessary trailing decimal zeros in Double and Float types, i.e., prefer `1` vs. `1.0`.
20+
21+
# Comments
22+
- Follow standard English grammar and punctuation.
23+
- End sentences with commas where appropriate.
24+
- Keep comments lean and purposeful — explain *why*, not *what*.
25+
- Comments must help understand the essence, not repeat what the code does.
26+
- Avoid filler words or redundant descriptions.

0 commit comments

Comments
 (0)