Add instruction for LLMs #29
Conversation
|
Warning Rate limit exceeded@nao1215 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 34 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (11)
WalkthroughAdds repository-wide development and AI-assistant guidelines (.cursorrules, .github/copilot-instructions.md, CLAUDE.md), inserts AI usage sections into CONTRIBUTING and localized CONTRIBUTING files (some duplicated), and removes the Makefile's version linker flags and the Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
This comment has been minimized.
This comment has been minimized.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (9)
.github/copilot-instructions.md (4)
3-5: Tighten the overview wording (grammar + precision).Clarify article usage and the returned type.
- filesql is a library that implements common functionality for loading CSV/TSV/LTSV/Parquet/Excel files into SQLite3 in-memory database and executing SQL queries. It returns standard sql.DB instances that developers are familiar with. + filesql is a library that implements common functionality for loading CSV/TSV/LTSV/Parquet/Excel files into an in-memory SQLite3 database and executing SQL queries. It returns a standard *sql.DB instance that developers are familiar with.
15-16: Align “no globals” rule with .cursorrules (prevent policy drift)..cursorrules allows a narrow config-package exception; this doc disallows globals unconditionally. Pick one policy and apply it repo-wide.
-- **No global variables**: Manage state through function arguments and return values +- **No global variables** (except in a dedicated config package and only when unavoidable, with justification): Manage state through function arguments and return values
41-41: Be explicit: Excel means .xlsx.Avoid ambiguity around legacy .xls.
-- CSV, TSV, LTSV, Parquet, Excel files +- CSV, TSV, LTSV, Parquet, Excel (.xlsx) files
69-72: Clarify auto-save trigger phrasing.“at Commit or db.Close timing” is awkward; specify exact triggers.
-- Handle auto-save at Commit or db.Close timing +- Support optional auto-save on transaction commit or when db.Close is called (if configured)CLAUDE.md (4)
3-3: Rephrase intro for clarity.Remove redundant quotes and make it direct.
-filesql is a library that implements the common functionality of the following commands: "Load files such as CSV into SQLite3 and execute SQL queries against CSV, etc." +filesql is a library that loads files (e.g., CSV) into SQLite3 and lets you execute SQL queries against them.
7-7: Use the precise Go type.Link text should reflect *sql.DB.
-filesql reads the contents of specified input files and returns [sql.DB](https://pkg.go.dev/database/sql#DB). +filesql reads the contents of specified input files and returns [*sql.DB](https://pkg.go.dev/database/sql#DB).
21-22: Clarify auto-save trigger phrasing.Match the wording used elsewhere.
-- Auto-save: Automatic saving at Commit or db.Close timing +- Auto-save: Optional saving on transaction commit or when db.Close is called
52-53: Escape the newline example and tidy wording.Small readability improvement.
-- Cross-platform support: Tests run on Linux, macOS, and Windows through GitHub Actions. Examples of non-cross-platform code include "concatenating paths without using `filepath.Join`" and "using "\n" for line breaks". +- Cross-platform support: Tests run on Linux, macOS, and Windows through GitHub Actions. Examples of non-cross-platform code include “concatenating paths without using `filepath.Join`” and “using '\n' for line breaks”..cursorrules (1)
21-21: Clarify the exception for globals to keep it exceptional.Make the carve‑out narrow and documented.
-- NO global variables (except in config package if absolutely needed) +- NO global variables (exception: a dedicated config package only when unavoidable; document rationale and usage)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
.cursorrules(1 hunks).github/copilot-instructions.md(1 hunks)CLAUDE.md(1 hunks)Makefile(0 hunks)
💤 Files with no reviewable changes (1)
- Makefile
🧰 Additional context used
🪛 LanguageTool
.github/copilot-instructions.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...uctions for filesql ## Project Overview filesql is a library that implements com...
(QB_NEW_EN)
[grammar] ~4-~4: There might be a mistake here.
Context: ...oading CSV/TSV/LTSV/Parquet/Excel files into SQLite3 in-memory database and executin...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...iples ### Test-Driven Development (TDD) - Always write test code first following T...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...sing octocov ### Code Quality Standards - No global variables: Manage state thro...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...tation ### Cross-Platform Compatibility - Ensure code works on Linux, macOS, and W...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...Guidelines ### When generating Go code: 1. Package structure: Every package must ...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...ternational contributors 3. Testing: - Use t.Run() for sub-tests with clear i...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...r parallel test execution where possible - Store test data in testdata directory ...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...r, embed.FS) ### Supported File Formats - CSV, TSV, LTSV, Parquet, Excel files - C...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...s - CSV, TSV, LTSV, Parquet, Excel files - Compressed formats: .gz, .bz2, .xz, .zst...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...Compressed formats: .gz, .bz2, .xz, .zst - Streaming support for large files (chunk...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...for large files (chunk-based processing) - Automatic type inference for columns (IN...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ... all README files in multiple languages: - README.md - doc/es/README.md - doc...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...es in multiple languages: - README.md - doc/es/README.md - doc/fr/README.md ...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...es: - README.md - doc/es/README.md - doc/fr/README.md - doc/ja/README.md ...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ...- doc/es/README.md - doc/fr/README.md - doc/ja/README.md - doc/ko/README.md ...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: ...- doc/fr/README.md - doc/ja/README.md - doc/ko/README.md - doc/ru/README.md ...
(QB_NEW_EN)
[grammar] ~60-~60: There might be a mistake here.
Context: ...- doc/ja/README.md - doc/ko/README.md - doc/ru/README.md - doc/zh-cn/README.m...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...- doc/ko/README.md - doc/ru/README.md - doc/zh-cn/README.md 2. Include sponsor ...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...ith clear documentation ### Type System - Use type inference for automatic column ...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ... Global variables or package-level state - Hardcoded paths or platform-specific cod...
(QB_NEW_EN)
[grammar] ~122-~122: There might be a mistake here.
Context: ...ardcoded paths or platform-specific code - Missing error handling - Undocumented pu...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ...m-specific code - Missing error handling - Undocumented public APIs - Test code wit...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...rror handling - Undocumented public APIs - Test code with excessive DRY that hurts ...
(QB_NEW_EN)
[grammar] ~125-~125: There might be a mistake here.
Context: ...ith excessive DRY that hurts readability - Direct stdout/stderr output from library...
(QB_NEW_EN)
CLAUDE.md
[grammar] ~9-~9: There might be a mistake here.
Context: ... easy to learn. ## Codebase Information ### Development Commands - make test: Run ...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...ase Information ### Development Commands - make test: Run tests and measure coverage (genera...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...le, viewable in browser with cover.html) - make lint: Code inspection with golangci-lint (.g...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...angci-lint (.golangci.yml configuration) - make clean: Delete generated files - make tools:...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...) - make clean: Delete generated files - make tools: Install dependency tools (golangci-lin...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...ile path, directory, io.Reader, embed.FS - Streaming: Chunk-based processing for la...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...: Chunk-based processing for large files - Type inference: Automatic column data ty...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ... data type detection (INTEGER/REAL/TEXT) - Auto-save: Automatic saving at Commit or...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...s write comments following go doc rules. - Remove duplicate code: After completing ...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...pdate the README at the following paths: - README.md - doc/es/README.md - doc/f...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ME at the following paths: - README.md - doc/es/README.md - doc/fr/README.md ...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...aths: - README.md - doc/es/README.md - doc/fr/README.md - doc/ja/README.md ...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ... - doc/es/README.md - doc/fr/README.md - doc/ja/README.md - doc/ko/README.md ...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ... - doc/fr/README.md - doc/ja/README.md - doc/ko/README.md - doc/ru/README.md ...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ... - doc/ja/README.md - doc/ko/README.md - doc/ru/README.md - doc/zh-cn/README.md...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ... - doc/ko/README.md - doc/ru/README.md - doc/zh-cn/README.md ## Testing - [Reada...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Unit test (linux) (windows-latest, 1.24)
- GitHub Check: golangci-lint
🔇 Additional comments (1)
.github/copilot-instructions.md (1)
55-63: Resolved: multilingual README paths verified. All referenced README files exist.
nao1215
force-pushed
the
nchika/llm-inst
branch
from
9d01e4a to
1993576
Compare
This comment has been minimized.
This comment has been minimized.
nao1215
force-pushed
the
nchika/llm-inst
branch
from
1993576 to
98918a3
Compare
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Actionable comments posted: 5
♻️ Duplicate comments (1)
.github/copilot-instructions.md (1)
55-61: Expand Copilot rules: parallel subtests and resource cleanup in examples.Prevent copy-paste bugs by codifying these two items in the checklist.
Apply:
When generating code suggestions, GitHub Copilot should: 1. Always suggest tests before implementation following TDD principles 2. Ensure all generated code follows the Effective Go guidelines 3. Include proper godoc comments for all public APIs 4. Suggest parallel test execution with `t.Parallel()` where appropriate 5. Use `filepath.Join()` for path operations to ensure cross-platform compatibility +6. For parallel subtests: rebind loop variables inside the loop (e.g., `tt := tt`) before `t.Run`, and call `t.Parallel()` inside each subtest (not only at the parent). +7. Demonstrate proper DB usage: check query errors, `defer rows.Close()`, and handle `rows.Err()` after iteration in examples.
🧹 Nitpick comments (9)
CLAUDE.md (3)
32-32: Align “no globals” rule with other docs (config exception).Other CONTRIBUTING docs mention an exception for a config package; this file states a blanket prohibition. Please reconcile to avoid confusion.
Proposed tweak:
-- No global variables: Do not use global variables. Manage state through function arguments and return values. +- No global variables: Do not use global variables (except where strictly necessary in the internal config package). Manage state through function arguments and return values.
21-21: Clarify auto-save semantics.“Automatic saving at Commit or db.Close timing” is ambiguous. Specify whether this refers to Tx.Commit vs. sql.DB.Close and exactly what is persisted.
Example:
-- Auto-save: Automatic saving at Commit or db.Close timing +- Auto-save: Automatically persist created tables/data on Tx.Commit() and when db.Close() is called (document exact scope and guarantees).
50-53: Add note on parallel subtests and loop-variable capture.When recommending t.Parallel(), include the common gotcha: rebind loop variables in subtests and avoid parallelizing the parent when subtests run in parallel.
Add a bullet:
- Parallel test execution: Use `t.Parallel()` to run tests in parallel whenever possible. +- Parallel subtests: Call `t.Parallel()` inside each subtest and rebind the loop variable (e.g., `tt := tt`) before `t.Run` to avoid capture bugs.doc/ru/CONTRIBUTING.md (1)
87-110: Optional: parallelize subtests, not the parent, and mention loop-variable rebind.Current example parallelizes only the parent. Consider moving t.Parallel() into subtests and rebinding loop variables when iterating test cases.
Example pattern:
for _, tt := range tests { tt := tt t.Run(tt.name, func(t *testing.T) { t.Parallel() // ... }) }doc/fr/CONTRIBUTING.md (2)
114-123: Minor FR style/wording nits (commas, “d’IA”).
- Add a light pause for readability and use “d’IA”.
-Nous encourageons activement l'utilisation d'assistants de codage IA pour améliorer la productivité et la qualité du code. Des outils comme Claude Code, GitHub Copilot et Cursor sont les bienvenus pour : +Nous encourageons activement l'utilisation d'assistants de codage IA, pour améliorer la productivité et la qualité du code. Des outils comme Claude Code, GitHub Copilot et Cursor sont les bienvenus pour : ... - - Les outils IA peuvent aider à générer des cas de test complets + - Les outils d’IA peuvent aider à générer des cas de test completsAlso applies to: 142-142
126-130: Link the referenced config files for convenience.Turn file names into clickable links.
-4. **Utiliser la configuration du projet** : Nous fournissons `CLAUDE.md`, `.cursorrules` et `.github/copilot-instructions.md` pour aider les assistants IA à comprendre nos standards de projet +4. **Utiliser la configuration du projet** : Nous fournissons [CLAUDE.md](../../CLAUDE.md), [`.cursorrules`](../../.cursorrules) et [`.github/copilot-instructions.md`](../../.github/copilot-instructions.md) pour aider les assistants d’IA à comprendre nos standards de projetCONTRIBUTING.md (2)
114-123: Tone tweak: “are welcome to help with” reads more naturally.Also consider making tool list sentence lead into bullets.
-We actively encourage the use of AI coding assistants to improve productivity and code quality. Tools like Claude Code, GitHub Copilot, and Cursor are welcome for: +We actively encourage the use of AI coding assistants to improve productivity and code quality. Tools like Claude Code, GitHub Copilot, and Cursor are welcome to help with:
126-130: Make referenced config files clickable.Improves discoverability.
-4. **Use project configuration**: We provide `CLAUDE.md`, `.cursorrules` and `.github/copilot-instructions.md` to help AI assistants understand our project standards +4. **Use project configuration**: We provide [CLAUDE.md](CLAUDE.md), [`.cursorrules`](.cursorrules), and [`.github/copilot-instructions.md`](.github/copilot-instructions.md) to help AI assistants understand our project standardsdoc/es/CONTRIBUTING.md (1)
112-123: Minor ES style nit about acronyms.Optionally use “LLM” (invariable) or “modelos de lenguaje” in headings per ES style.
-## Uso de Asistentes de IA (LLMs) +## Uso de Asistentes de IA (LLM)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (11)
.cursorrules(1 hunks).github/copilot-instructions.md(1 hunks)CLAUDE.md(1 hunks)CONTRIBUTING.md(2 hunks)Makefile(0 hunks)doc/es/CONTRIBUTING.md(2 hunks)doc/fr/CONTRIBUTING.md(2 hunks)doc/ja/CONTRIBUTING.md(2 hunks)doc/ko/CONTRIBUTING.md(2 hunks)doc/ru/CONTRIBUTING.md(2 hunks)doc/zh-cn/CONTRIBUTING.md(2 hunks)
💤 Files with no reviewable changes (1)
- Makefile
🚧 Files skipped from review as they are similar to previous changes (1)
- .cursorrules
🧰 Additional context used
🪛 LanguageTool
.github/copilot-instructions.md
[grammar] ~9-~9: There might be a mistake here.
Context: ... easy to learn. ## Codebase Information ### Development Commands - make test: Run ...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...ase Information ### Development Commands - make test: Run tests and measure coverage (genera...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...le, viewable in browser with cover.html) - make lint: Code inspection with golangci-lint (.g...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...angci-lint (.golangci.yml configuration) - make clean: Delete generated files - make tools:...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...) - make clean: Delete generated files - make tools: Install dependency tools (golangci-lin...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...ile path, directory, io.Reader, embed.FS - Streaming: Chunk-based processing for la...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...: Chunk-based processing for large files - Type inference: Automatic column data ty...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ... data type detection (INTEGER/REAL/TEXT) - Auto-save: Automatic saving at Commit or...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...s write comments following go doc rules. - Remove duplicate code: After completing ...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...pdate the README at the following paths: - README.md - doc/es/README.md - doc/f...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ME at the following paths: - README.md - doc/es/README.md - doc/fr/README.md ...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...aths: - README.md - doc/es/README.md - doc/fr/README.md - doc/ja/README.md ...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ... - doc/es/README.md - doc/fr/README.md - doc/ja/README.md - doc/ko/README.md ...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ... - doc/fr/README.md - doc/ja/README.md - doc/ko/README.md - doc/ru/README.md ...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ... - doc/ja/README.md - doc/ko/README.md - doc/ru/README.md - doc/zh-cn/README.md...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ... - doc/ko/README.md - doc/ru/README.md - doc/zh-cn/README.md ## Testing - [Reada...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...irectory ## GitHub Copilot Instructions When generating code suggestions, GitHub...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...code suggestions, GitHub Copilot should: 1. Always suggest tests before implementati...
(QB_NEW_EN)
CLAUDE.md
[grammar] ~9-~9: There might be a mistake here.
Context: ... easy to learn. ## Codebase Information ### Development Commands - make test: Run ...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...ase Information ### Development Commands - make test: Run tests and measure coverage (genera...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...le, viewable in browser with cover.html) - make lint: Code inspection with golangci-lint (.g...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...angci-lint (.golangci.yml configuration) - make clean: Delete generated files - make tools:...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...) - make clean: Delete generated files - make tools: Install dependency tools (golangci-lin...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...ile path, directory, io.Reader, embed.FS - Streaming: Chunk-based processing for la...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...: Chunk-based processing for large files - Type inference: Automatic column data ty...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ... data type detection (INTEGER/REAL/TEXT) - Auto-save: Automatic saving at Commit or...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...s write comments following go doc rules. - Remove duplicate code: After completing ...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...pdate the README at the following paths: - README.md - doc/es/README.md - doc/f...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ME at the following paths: - README.md - doc/es/README.md - doc/fr/README.md ...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...aths: - README.md - doc/es/README.md - doc/fr/README.md - doc/ja/README.md ...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ... - doc/es/README.md - doc/fr/README.md - doc/ja/README.md - doc/ko/README.md ...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ... - doc/fr/README.md - doc/ja/README.md - doc/ko/README.md - doc/ru/README.md ...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ... - doc/ja/README.md - doc/ko/README.md - doc/ru/README.md - doc/zh-cn/README.md...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ... - doc/ko/README.md - doc/ru/README.md - doc/zh-cn/README.md ## Testing - [Reada...
(QB_NEW_EN)
CONTRIBUTING.md
[grammar] ~116-~116: There might be a mistake here.
Context: ...welcome for: - Writing boilerplate code - Generating comprehensive test cases - Im...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ...de - Generating comprehensive test cases - Improving documentation - Refactoring ex...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ...ive test cases - Improving documentation - Refactoring existing code - Finding pote...
(QB_NEW_EN)
[grammar] ~119-~119: There might be a mistake here.
Context: ...ocumentation - Refactoring existing code - Finding potential bugs - Suggesting perf...
(QB_NEW_EN)
[grammar] ~120-~120: There might be a mistake here.
Context: ...g existing code - Finding potential bugs - Suggesting performance optimizations - T...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...s - Suggesting performance optimizations - Translating documentation ### Guideline...
(QB_NEW_EN)
doc/es/CONTRIBUTING.md
[misspelling] ~112-~112: El plural de las siglas no se marca gráficamente.
Context: ... }) } ``` ## Uso de Asistentes de IA (LLMs) Fomentamos activamente el uso de asis...
(SIGLAS)
[uncategorized] ~114-~114: Probablemente falta un signo de puntuación.
Context: ... código. Herramientas como Claude Code, GitHub Copilot y Cursor son bienvenidas para: ...
(AI_ES_GGEC_MISSING_PUNCTUATION)
doc/fr/CONTRIBUTING.md
[uncategorized] ~114-~114: Une virgule semble être requise.
Context: ... du code. Des outils comme Claude Code, GitHub Copilot et Cursor sont les bienvenus po...
(AI_FR_HYDRA_LEO_MISSING_COMMA)
[typographical] ~128-~128: Caractère d’apostrophe incorrect.
Context: ...oit passer tous les tests et le linting (make test et make lint) 4. **Utiliser...
(APOS_INCORRECT)
[typographical] ~128-~128: Caractère d’apostrophe incorrect.
Context: ...les tests et le linting (make test et make lint) 4. **Utiliser la configuration du proj...
(APOS_INCORRECT)
[typographical] ~129-~129: Caractère d’apostrophe incorrect.
Context: ...guration du projet** : Nous fournissons CLAUDE.md, .cursorrules et `.github/copilot-ins...
(APOS_INCORRECT)
[uncategorized] ~142-~142: Une phrase longue peut apporter une perte de sens pour le lecteur. Celle-ci peut donc être divisée afin d’apporter de la clarté et du rythme.
Context: ...es tests qui reproduisent le bogue - Les outils IA peuvent aider à générer des c...
(POINT_DET)
doc/ru/CONTRIBUTING.md
[uncategorized] ~120-~120: Более 4 существительных в родительном падеже подряд. Перефразируйте предложение.
Context: ...ществующего кода - Поиска потенциальных ошибок - Предложения оптимизации производительности - Перевода документации ### Руководство по разраб...
(noun_genitive_3)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Unit test (linux) (windows-latest, 1.24)
🔇 Additional comments (3)
doc/ja/CONTRIBUTING.md (2)
112-123: LLM usage section reads well.Content and placement look good.
142-142: Good addition to PR checklist.Encouraging AI-generated tests here is helpful.
doc/es/CONTRIBUTING.md (1)
142-142: Good checklist addition.Clear and actionable.
| ### Pautas para el Desarrollo Asistido por IA | ||
|
|
||
| 1. **Revisar todo el código generado**: Siempre revisa y comprende el código generado por IA antes de hacer commit | ||
| 2. **Mantener la coherencia**: Asegúrate de que el código generado por IA siga nuestros estándares de codificación en CLAUDE.md | ||
| 3. **Probar exhaustivamente**: El código generado por IA debe pasar todas las pruebas y el linting (`make test` y `make lint`) | ||
| 4. **Usar configuración del proyecto**: Proporcionamos `CALUDE.md`, `.cursorrules` y `.github/copilot-instructions.md` para ayudar a los asistentes de IA a entender nuestros estándares del proyecto | ||
|
|
There was a problem hiding this comment.
Typo in file name (CLAUDE.md).
Correct “CALUDE.md” → “CLAUDE.md”.
-4. **Usar configuración del proyecto**: Proporcionamos `CALUDE.md`, `.cursorrules` y `.github/copilot-instructions.md` para ayudar a los asistentes de IA a entender nuestros estándares del proyecto
+4. **Usar configuración del proyecto**: Proporcionamos `CLAUDE.md`, `.cursorrules` y `.github/copilot-instructions.md` para ayudar a los asistentes de IA a entender nuestros estándares del proyecto📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Pautas para el Desarrollo Asistido por IA | |
| 1. **Revisar todo el código generado**: Siempre revisa y comprende el código generado por IA antes de hacer commit | |
| 2. **Mantener la coherencia**: Asegúrate de que el código generado por IA siga nuestros estándares de codificación en CLAUDE.md | |
| 3. **Probar exhaustivamente**: El código generado por IA debe pasar todas las pruebas y el linting (`make test` y `make lint`) | |
| 4. **Usar configuración del proyecto**: Proporcionamos `CALUDE.md`, `.cursorrules` y `.github/copilot-instructions.md` para ayudar a los asistentes de IA a entender nuestros estándares del proyecto | |
| ### Pautas para el Desarrollo Asistido por IA | |
| 1. **Revisar todo el código generado**: Siempre revisa y comprende el código generado por IA antes de hacer commit | |
| 2. **Mantener la coherencia**: Asegúrate de que el código generado por IA siga nuestros estándares de codificación en CLAUDE.md | |
| 3. **Probar exhaustivamente**: El código generado por IA debe pasar todas las pruebas y el linting (`make test` y `make lint`) | |
| 4. **Usar configuración del proyecto**: Proporcionamos `CLAUDE.md`, `.cursorrules` y `.github/copilot-instructions.md` para ayudar a los asistentes de IA a entender nuestros estándares del proyecto |
🤖 Prompt for AI Agents
In doc/es/CONTRIBUTING.md around lines 124 to 130, there's a typo in the
referenced filename "CALUDE.md"; change it to "CLAUDE.md" and verify the
corrected filename is consistent with the repo (update any other occurrences in
this file or nearby docs), ensuring links or file references point to the
existing CLAUDE.md.
nao1215
force-pushed
the
nchika/llm-inst
branch
from
98918a3 to
775b058
Compare
Code Metrics Report
Details | | main (a55949a) | #29 (2522900) | +/- |
|---------------------|----------------|---------------|------|
| Coverage | 83.7% | 83.7% | 0.0% |
| Files | 9 | 9 | 0 |
| Lines | 1663 | 1663 | 0 |
| Covered | 1393 | 1393 | 0 |
- | Test Execution Time | 52s | 53s | +1s |Reported by octocov |
Summary by CodeRabbit