chore: add universal Qodo best_practices.md - #4
vaulttec-dev wants to merge 1 commit into
Conversation
Стеко-незалежний набір правил для Qodo PR-Agent /improve; читається автоматично.
📝 WalkthroughWalkthroughДодано ChangesІнженерні правила
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: Poem
🚥 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 |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
best_practices.md (3)
61-64: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winУточніть політику закріплення залежностей.
Безумовна вимога закріплювати всі версії може заохочувати exact pinning у маніфесті та ускладнювати контрольовані security-оновлення. Краще вимагати lockfile/constraints для відтворюваних збірок і заборонити лише неявні major-апгрейди.
🤖 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 `@best_practices.md` around lines 61 - 64, Уточніть пункт про залежності: замініть безумовну вимогу закріплювати версії на вимогу використовувати lockfile або constraints для відтворюваних збірок, зберігши заборону неявних major-оновлень у звичайних PR.
45-45: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winРозділіть вимоги до regression-тестів і нової поведінки.
Тест нової функціональності не завжди може «падати до зміни» — часто його додають одночасно з реалізацією. Цю вимогу слід застосовувати до regression-тестів для багфіксів, а для нової поведінки вимагати перевірку нового контракту.
Запропоноване формулювання
-- Нова поведінка й фікси багів супроводжуються тестами, що падали б до зміни. +- Фікси багів супроводжуються regression-тестами, що падали б до зміни; нова поведінка — тестами нового контракту.🤖 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 `@best_practices.md` at line 45, Оновіть рекомендацію в best_practices.md: вимогу про тест, який падає до зміни, застосовуйте лише до regression-тестів для виправлення помилок; для нової поведінки вимагайте тест, що перевіряє новий контракт, без обов’язкової невдачі до реалізації.
13-15: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winЗробіть правила стеко-незалежними.
Терміни
promises,awaited,null/undefinedі truthiness прив’язані переважно до JS/TS та можуть спричиняти нерелевантні поради для інших стеків. Сформулюйте їх через загальні поняття асинхронності, відсутніх значень і валідних false-like значень, залишивши специфічні приклади лише в дужках.🤖 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 `@best_practices.md` around lines 13 - 15, Оновіть правила в best_practices.md, замінивши JS/TS-специфічні терміни в пунктах про асинхронність, відсутні значення та false-like значення на стеко-незалежні формулювання. Збережіть приклади на кшталт promises, await, null/undefined і 0/""/false лише як необов’язкові приклади в дужках.
🤖 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.
Nitpick comments:
In `@best_practices.md`:
- Around line 61-64: Уточніть пункт про залежності: замініть безумовну вимогу
закріплювати версії на вимогу використовувати lockfile або constraints для
відтворюваних збірок, зберігши заборону неявних major-оновлень у звичайних PR.
- Line 45: Оновіть рекомендацію в best_practices.md: вимогу про тест, який падає
до зміни, застосовуйте лише до regression-тестів для виправлення помилок; для
нової поведінки вимагайте тест, що перевіряє новий контракт, без обов’язкової
невдачі до реалізації.
- Around line 13-15: Оновіть правила в best_practices.md, замінивши
JS/TS-специфічні терміни в пунктах про асинхронність, відсутні значення та
false-like значення на стеко-незалежні формулювання. Збережіть приклади на
кшталт promises, await, null/undefined і 0/""/false лише як необов’язкові
приклади в дужках.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: a6d112d0-ca60-4a30-bebc-76e30e100391
📒 Files selected for processing (1)
best_practices.md
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Adds a stack-agnostic best_practices.md at the repository root so Qodo PR-Agent /improve can automatically apply organization-wide guidance during PR reviews.
Changes:
- Introduces a universal best-practices guide covering correctness, security, API boundaries, data, concurrency, tests, performance, maintainability, and dependencies/config.
- Documents where project-specific rules should live (outside this universal file) and notes PR-Agent size constraints.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Правила, специфічні для проєкту (фреймворки, доменна логіка, назви пакетів), | ||
| НЕ додавай сюди — їм місце в `.pr_agent.toml` → [pr_reviewer]/[pr_code_suggestions] extra_instructions. | ||
| Ліміт PR-Agent: 800 рядків. Тримай пункти короткими й перевірюваними. |
Що це
Додає універсальний, стеко-незалежний
best_practices.mdу корінь репо.Qodo PR-Agent
/improveчитає цей файл автоматично і, якщо код у PR порушуєгайдлайн, додає поради з лейблом
Organization best practice.Джерело шаблону:
qodo-pr-agent/templates/best_practices.md.Summary by cubic
Adds a universal, stack-agnostic
best_practices.mdat the repo root forQodo PR-Agent/improve. The agent auto-reads it and will add "Organization best practice" suggestions when PRs break a rule.Written for commit c9d8e81. Summary will update on new commits.
Summary by CodeRabbit
Greptile Summary
Додано універсальний файл інженерних рекомендацій для Qodo PR-Agent.
Confidence Score: 5/5
Pull Request виглядає безпечним для злиття.
Зміни обмежені новим Markdown-файлом із рекомендаціями та не впливають на виконуваний код, дані, залежності чи безпекові межі застосунку.
Important Files Changed
Reviews (1): Last reviewed commit: "chore: add universal Qodo best_practices..." | Re-trigger Greptile