docs: add AGENTS.md and supplementary developer guides#312
Conversation
Add comprehensive developer/agent guide with: - AGENTS.md: project overview, architecture, quick start, coding conventions, testing, CI/CD, PR workflow, security - docs/coding-standards.rst: Python style, type hints, docstrings, best practices for the project - docs/security-guide.rst: bandit, Redis connection security, input validation, dependency security Co-authored-by: Masoud Lakestani <46046899+MasoudLakestani@users.noreply.github.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 40b004d945
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| try: | ||
| self.redis_key_check_interval = int(self.redis_key_check_interval) | ||
| except (TypeError, ValueError): | ||
| raise ValueError("redis_key_check_interval must be an integer or None") |
There was a problem hiding this comment.
Reject negative redis_key_check_interval values
The interval parser accepts negative numbers (e.g. -1) and stores them as-is, but _maybe_check_priority_scan() treats any truthy interval as enabled and checks current_time - last_scan >= interval, which is always true for negative values. In multi-key mode this forces a priority scan on every polling cycle, causing immediate preemption and extra Redis cardinality calls instead of the documented periodic behavior; a mistaken negative setting should be rejected up front.
Useful? React with 👍 / 👎.
Summary
Adds comprehensive developer/agent guide to the repository, covering everything needed for efficient contribution:
AGENTS.md — Main guide at repo root covering:
docs/coding-standards.rst — Python coding standards:
docs/security-guide.rst — Security guide:
Closes #310