Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Description

<!--- Describe your changes in short detail -->
## Types of changes

<!-- '- [ ] file name(clickable): change made -->
- [ ]

## Checklist

- [ ] Updated ChangeLog
- [ ]
- [ ] All tests passed.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ nadunssh
id_rsa
id_ed25519
/postman/collections/*/.resources/definition.yaml
.agents
85 changes: 43 additions & 42 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
thiserror = "2.0"
tokio = { version = "1", features = ["full"] }
regex = "1.11"
tokio-stream = "0.1"
tower = "0.5"
tower-http = { version = "0.6", features = ["cors", "trace", "compression-full", "fs"] }
Expand Down
5 changes: 3 additions & 2 deletions GEMINI.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nadzu Backend - Engineering Standards & Policies

This document serves as the foundational mandate for all engineering work on this codebase. It applies to both human developers and AI agents. Strict adherence is required to maintain the "Anti-Corruption Layer" and high-performance nature of the system.
This document serves as the foundational mandate for all engineering work on naduns codebase. It applies to both human developers and AI agents. Strict adherence is required to maintain the security and high-performance nature of the system.
Comment thread
nxdun marked this conversation as resolved.

## 1. Architectural Integrity

Expand Down Expand Up @@ -61,9 +61,10 @@ This document serves as the foundational mandate for all engineering work on thi
* **Clippy**: Must be zero-warning.
* **Rustfmt**: Must be applied to every file.
* **Makefile**: Use `make c` for a full validation suite before concluding any task.
* Use -j (nproc) for parallel builds and tests to speed up the shell commands.

### Documentation
* All public-facing methods and services must have `///` (Rustdoc) comments explaining intent and behavior.
* All public-facing methods and services must have `///` (Rustdoc) comments explaining intent and behavior.do not over document, make guesses about the unseen code.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Clarify the documentation guideline.

The current wording "do not over document, make guesses about the unseen code" is grammatically awkward and potentially contradictory—documentation guidelines typically discourage guessing. Consider rephrasing for clarity.

📝 Suggested fix
-*   All public-facing methods and services must have `///` (Rustdoc) comments explaining intent and behavior.do not over document, make guesses about the unseen code.
+*   All public-facing methods and services must have `///` (Rustdoc) comments explaining intent and behavior. Avoid over-documentation; do not make assumptions about unseen code.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@GEMINI.md` at line 67, Replace the awkward clause in the bullet that reads
"do not over document, make guesses about the unseen code" with a clear
directive: require /// Rustdoc comments for all public-facing methods and
services that explain intent and behavior, and explicitly forbid adding
speculative or guessed details about code you haven't inspected; if unsure,
write minimal, factual intent or ask the code owner for clarification. Update
the single-line bullet containing "All public-facing methods and services must
have `///` (Rustdoc) comments explaining intent and behavior.do not over
document, make guesses about the unseen code." to this clearer phrasing so
readers know to document intent accurately and avoid speculation.

* Complex logic (like the Midnight Snap caching strategy) must be documented inline.

---
Expand Down
Loading
Loading