docs: add agents.md file - #1071
Conversation
dosubot
Bot
added
the
size:L
📝 WalkthroughWalkthroughThe pull request adds repository guidance in ChangesRepository maintenance
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with 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.
Inline comments:
In `@AGENTS.md`:
- Line 48: Add the text language identifier to all five fenced code block
openings in AGENTS.md, including the directory-tree and branch-name examples, so
each uses a text-labeled fence and satisfies MD040.
- Line 34: Correct the Gin guidance to state that *gin.Context is not compatible
with all standard-library signatures; instruct callers to pass c.Request and
c.Writer for functions requiring *http.Request or http.ResponseWriter, or use an
appropriate adapter.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: bd45fcb3-396f-4c4d-b6a7-709305d4a3c5
📒 Files selected for processing (3)
.gitignoreAGENTS.mdMakefile
|
|
||
| When updating translations, you should only update the `frontend/src/lib/i18n/locales/en.json` and `frontend/src/lib/i18n/locales/en-US.json` files (they should be exactly the same). Crowdin will handle the generation of the keys for the rest of the available locales. NEVER hard-code plain English in the frontend, instead use the available `i18next` library and the respective translations. | ||
|
|
||
| For the REST framework we use Gin. However functions or methods should avoid using the Gin Context (`gin.Context`) and default to stdlib arguments and outputs. The Gin Context is compatible with all stdlib declarations so it will not pose any issues with them. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
go doc github.com/gin-gonic/gin.Context
rg -n --glob '*.go' 'gin\.Context|http\.ResponseWriter|\*http\.Request' .Repository: tinyauthapp/tinyauth
Length of output: 13717
🏁 Script executed:
#!/bin/bash
set -euo pipefail
sed -n '28,38p' AGENTS.md
go doc github.com/gin-gonic/gin.ResponseWriter
go doc net/http.HandlerRepository: tinyauthapp/tinyauth
Length of output: 4531
Correct the gin.Context compatibility guidance.
*gin.Context is not compatible with all standard-library signatures. Pass c.Request and c.Writer to functions that require *http.Request and http.ResponseWriter, or use an adapter.
🤖 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 `@AGENTS.md` at line 34, Correct the Gin guidance to state that *gin.Context is
not compatible with all standard-library signatures; instruct callers to pass
c.Request and c.Writer for functions requiring *http.Request or
http.ResponseWriter, or use an appropriate adapter.
Source: MCP tools
|
|
||
| A high level of the backend is as follows: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add language identifiers to the fenced code blocks.
markdownlint-cli2 reports MD040 for these five fence openings. Use text for the directory trees and branch-name examples.
Proposed fix
-```
+```textBased on static analysis, markdownlint-cli2 reports MD040 on these lines.
Also applies to: 73-73, 133-133, 139-139, 145-145
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 48-48: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@AGENTS.md` at line 48, Add the text language identifier to all five fenced
code block openings in AGENTS.md, including the directory-tree and branch-name
examples, so each uses a text-labeled fence and satisfies MD040.
Source: Linters/SAST tools
|
|
||
| ## Overview | ||
|
|
||
| Tinyauth is a lightweight and open-source authentication server written in Go and TypeScript (React). It acts as either an authentication middleware (forward_auth, ext_authz or auth_request) to protect applications using proxy authentication or as an OpenID Connect provider to offer SSO (Single-Sign-On) to your self-hosted apps. It supports 2FA (via TOTP), LDAP, access controls (ACLs), local users and SSO users via OAuth. Tinyauth can be deployed with Docker, Kubernetes or bare-metal with a binary. |
There was a problem hiding this comment.
| Tinyauth is a lightweight and open-source authentication server written in Go and TypeScript (React). It acts as either an authentication middleware (forward_auth, ext_authz or auth_request) to protect applications using proxy authentication or as an OpenID Connect provider to offer SSO (Single-Sign-On) to your self-hosted apps. It supports 2FA (via TOTP), LDAP, access controls (ACLs), local users and SSO users via OAuth. Tinyauth can be deployed with Docker, Kubernetes or bare-metal with a binary. | |
| Tinyauth is a lightweight and open-source authentication server written in Go and TypeScript (React). It acts as either an authentication middleware (forward_auth, ext_authz or auth_request) to protect applications using proxy authentication or as an OpenID Connect provider to offer SSO (Single-Sign-On) to your self-hosted apps. It supports local users with optional 2FA (via TOTP), LDAP, SSO users via OAuth, and access controls (ACLs). Tinyauth can be deployed with Docker, Kubernetes or bare-metal with a binary. |
| feat/add-oauth-support | ||
| ``` | ||
|
|
||
| The smaller branch name, the better. |
There was a problem hiding this comment.
Maybe something like Shorter branch names that still describe the general change are preferred ?
2 participants
Summary by CodeRabbit
Documentation
Chores