-
Notifications
You must be signed in to change notification settings - Fork 21
Add AGENTS.md #1588
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Add AGENTS.md #1588
Conversation
AGENTS.md
Outdated
|
|
||
| ## Coding Style & Naming Conventions | ||
| - Stick to Nim’s two-space indentation, UTF-8 files, and `lower_snake_case` module names. Types stay `PascalCase`, procs `camelCase`, and exported symbols need a trailing `*`. | ||
| - Group imports (`import std / [syncio, parseopt]`), keep shared constants in `src/lib`, and compose features through the existing `gear2` helper modules instead of ad-hoc globals. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope, gear2 is dead except for its module name handling code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there an alternative or just go ad-hoc? I'd say just edit it and commit?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New features typically are edits to tags.md then run nim c -r tools/gen_tags, then the Nim compiler hints at the missing cases.
Remove incorrect docs
I don’t know how accurate this is, but it looks like a reasonable start.