tyiu/damus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update AGENTS.md

Browse Source 
- add nesting rules
- add nostrdb consideration
- change code commentary to docstring coverage requirement
This commit is contained in:
alltheseas
2025-12-29 14:41:56 -06:00
committed by GitHub
parent 20dc672dbf
commit 0cbeaf8ea8
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
AGENTS.md
View File

@@ -40,5 +40,7 @@ Damus is an iOS client built around a local relay model ([damus-io/damus#3204](h
3. Commits should be standalone. 3. Commits should be standalone.
4. Code should be human readable. 4. Code should be human readable.
5. Code should be human reviewable. 5. Code should be human reviewable.
6. Use code comments to add context. 6. Ensure docstring coverage for any code added, or modified.
7. Review and follow `pull_request_template.md` when creating PRs for iOS Damus. 7. Review and follow `pull_request_template.md` when creating PRs for iOS Damus.
8. Ensure nevernesting: favor early returns and guard clauses over deeply nested conditionals; simplify control flow by exiting early instead of wrapping logic in multiple layers of `if` statements.
9. Before proposing changes, please **review and analyze if a change or upgrade to nostrdb** is beneficial to the change at hand.