Skip to content

Commit e2af770

Browse files
committed
Merge origin/develop into codex-integration-by-hooks
Signed-off-by: Jin Ku <jin.ku@sendbird.com>
2 parents ace64f4 + a919335 commit e2af770

40 files changed

Lines changed: 346 additions & 211 deletions

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ PRs target the **`develop`** branch, not `main`. All commits require a DCO sign-
5252

5353
rtk routes CLI commands via a Clap `Commands` enum in `main.rs` to specialized filter modules in `src/cmds/*/`, each executing the underlying command and compressing output. Token savings are tracked in SQLite via `src/core/tracking.rs`.
5454

55-
For full details see [ARCHITECTURE.md](../ARCHITECTURE.md) and [docs/TECHNICAL.md](../docs/TECHNICAL.md). Module responsibilities are documented in each folder's `README.md` and each file's `//!` doc header.
55+
For full details see [ARCHITECTURE.md](../docs/contributing/ARCHITECTURE.md) and [docs/contributing/TECHNICAL.md](../docs/contributing/TECHNICAL.md). Module responsibilities are documented in each folder's `README.md` and each file's `//!` doc header.
5656

5757
## Key Conventions
5858

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ cargo generate-rpm # RPM package (needs cargo-generate-rpm, after rel
7070
rtk uses a **command proxy architecture**: `main.rs` routes CLI commands via a Clap `Commands` enum to specialized filter modules in `src/cmds/*/`, each of which executes the underlying command and compresses its output. Token savings are tracked in SQLite via `src/core/tracking.rs`.
7171

7272
For the full architecture, component details, and module development patterns, see:
73-
- [ARCHITECTURE.md](ARCHITECTURE.md) — System design, module organization, filtering strategies, error handling
74-
- [docs/TECHNICAL.md](docs/TECHNICAL.md) — End-to-end flow, folder map, hook system, filter pipeline
73+
- [ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md) — System design, module organization, filtering strategies, error handling
74+
- [docs/contributing/TECHNICAL.md](docs/contributing/TECHNICAL.md) — End-to-end flow, folder map, hook system, filter pipeline
7575

7676
Module responsibilities are documented in each folder's `README.md` and each file's `//!` doc header. Browse `src/cmds/*/` to discover available filters.
7777

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- [Report an Issue](../../issues/new)
88
- [Open Pull Requests](../../pulls)
99
- [Start a Discussion](../../discussions)
10-
- [Technical Documentation](docs/TECHNICAL.md) — Architecture, end-to-end flow, folder map, how to write tests
10+
- [Technical Documentation](docs/contributing/TECHNICAL.md) — Architecture, end-to-end flow, folder map, how to write tests
1111

1212
---
1313

@@ -203,7 +203,7 @@ your branch --> develop (review + CI + integration testing) --> version branch -
203203

204204
Every change **must** include tests. We follow **TDD (Red-Green-Refactor)**: write a failing test first, implement the minimum to pass, then refactor.
205205

206-
For how to write tests (fixtures, snapshots, token savings verification), see [docs/TECHNICAL.md — Testing](docs/TECHNICAL.md#testing).
206+
For how to write tests (fixtures, snapshots, token savings verification), see [docs/contributing/TECHNICAL.md — Testing](docs/contributing/TECHNICAL.md#testing).
207207

208208
### Test Types
209209

@@ -242,12 +242,12 @@ Every change **must** include documentation updates. Use this table to find whic
242242
| New Rust filter (`src/cmds/`) | Ecosystem `README.md` (e.g., `src/cmds/git/README.md`), [README.md](README.md) command list, [CHANGELOG.md](CHANGELOG.md) |
243243
| New TOML filter (`src/filters/`) | [src/filters/README.md](src/filters/README.md) if naming conventions change, [README.md](README.md) command list, [CHANGELOG.md](CHANGELOG.md) |
244244
| New rewrite pattern | `src/discover/rules.rs` — see [Adding a New Command Filter](src/cmds/README.md#adding-a-new-command-filter) |
245-
| Core infrastructure (`src/core/`) | [src/core/README.md](src/core/README.md), [docs/TECHNICAL.md](docs/TECHNICAL.md) if flow changes |
245+
| Core infrastructure (`src/core/`) | [src/core/README.md](src/core/README.md), [docs/contributing/TECHNICAL.md](docs/contributing/TECHNICAL.md) if flow changes |
246246
| Hook system (`src/hooks/`) | [src/hooks/README.md](src/hooks/README.md), [hooks/README.md](hooks/README.md) for agent-facing docs |
247-
| Architecture or design change | [ARCHITECTURE.md](ARCHITECTURE.md), [docs/TECHNICAL.md](docs/TECHNICAL.md) |
247+
| Architecture or design change | [ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md), [docs/contributing/TECHNICAL.md](docs/contributing/TECHNICAL.md) |
248248
| Bug fix or breaking change | [CHANGELOG.md](CHANGELOG.md) |
249249

250-
**Navigation**: [CONTRIBUTING.md](CONTRIBUTING.md) (you are here) → [docs/TECHNICAL.md](docs/TECHNICAL.md) (architecture + flow) → each folder's `README.md` (implementation details).
250+
**Navigation**: [CONTRIBUTING.md](CONTRIBUTING.md) (you are here) → [docs/contributing/TECHNICAL.md](docs/contributing/TECHNICAL.md) (architecture + flow) → each folder's `README.md` (implementation details).
251251

252252
Keep documentation concise and practical -- examples over explanations.
253253

DISCLAIMER.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Disclaimer
2+
3+
## No Warranty
4+
5+
This software is provided "AS IS", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. The entire risk as to the quality and performance of the software is with you.
6+
7+
## Limitation of Liability
8+
9+
In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software. This includes, without limitation, any direct, indirect, incidental, special, exemplary, or consequential damages (including but not limited to loss of data, loss of profits, or business interruption).
10+
11+
## Precompiled Binaries
12+
13+
Precompiled binaries are provided solely for convenience and are covered by the same license as the source code (Apache License 2.0). They are provided without warranties or conditions of any kind. You are responsible for verifying the integrity and suitability of any binary before use. Always verify checksums when available.
14+
15+
## Third-Party Dependencies
16+
17+
This software incorporates third-party open-source components, each governed by their respective licenses. The authors make no representations or warranties regarding these dependencies and accept no liability for any issues arising from their use.
18+
19+
## Use at Your Own Risk
20+
21+
This software interacts with your development environment, file system, and external commands. It is your responsibility to ensure that its use is appropriate for your environment and complies with any applicable policies, regulations, or agreements. The authors are not responsible for any unintended side effects resulting from its use.
22+
23+
## Telemetry
24+
25+
This software collects anonymous, aggregate usage metrics by default and can be disabled at any time. No personally identifiable information, source code, file paths, command arguments, or secrets are collected. See the README for full details and opt-out instructions.
26+
27+
---
28+
29+
See [LICENSE](LICENSE) for the full terms of the Apache License 2.0 under which this software is distributed.

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<a href="https://www.rtk-ai.app">Website</a> &bull;
1919
<a href="#installation">Install</a> &bull;
2020
<a href="docs/TROUBLESHOOTING.md">Troubleshooting</a> &bull;
21-
<a href="ARCHITECTURE.md">Architecture</a> &bull;
21+
<a href="docs/contributing/ARCHITECTURE.md">Architecture</a> &bull;
2222
<a href="https://discord.gg/RySmvNF5kF">Discord</a>
2323
</p>
2424

@@ -494,7 +494,7 @@ brew uninstall rtk # If installed via Homebrew
494494

495495
- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Fix common issues
496496
- **[INSTALL.md](INSTALL.md)** - Detailed installation guide
497-
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Technical architecture
497+
- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - Technical architecture
498498
- **[SECURITY.md](SECURITY.md)** - Security policy and PR review process
499499
- **[AUDIT_GUIDE.md](docs/AUDIT_GUIDE.md)** - Token savings analytics guide
500500

@@ -529,3 +529,7 @@ Join the community on [Discord](https://discord.gg/RySmvNF5kF).
529529
## License
530530

531531
MIT License - see [LICENSE](LICENSE) for details.
532+
533+
## Disclaimer
534+
535+
See [DISCLAIMER.md](DISCLAIMER.md).

README_es.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<a href="https://www.rtk-ai.app">Sitio web</a> &bull;
1919
<a href="#instalacion">Instalar</a> &bull;
2020
<a href="docs/TROUBLESHOOTING.md">Solucion de problemas</a> &bull;
21-
<a href="ARCHITECTURE.md">Arquitectura</a> &bull;
21+
<a href="docs/contributing/ARCHITECTURE.md">Arquitectura</a> &bull;
2222
<a href="https://discord.gg/RySmvNF5kF">Discord</a>
2323
</p>
2424

@@ -146,7 +146,7 @@ rtk discover # Descubrir ahorros perdidos
146146

147147
- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Resolver problemas comunes
148148
- **[INSTALL.md](INSTALL.md)** - Guia de instalacion detallada
149-
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Arquitectura tecnica
149+
- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - Arquitectura tecnica
150150

151151
## Contribuir
152152

@@ -157,3 +157,7 @@ Unete a la comunidad en [Discord](https://discord.gg/RySmvNF5kF).
157157
## Licencia
158158

159159
Licencia MIT - ver [LICENSE](LICENSE) para detalles.
160+
161+
## Descargo de responsabilidad
162+
163+
Ver [DISCLAIMER.md](DISCLAIMER.md).

README_fr.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<a href="https://www.rtk-ai.app">Site web</a> &bull;
1919
<a href="#installation">Installer</a> &bull;
2020
<a href="docs/TROUBLESHOOTING.md">Depannage</a> &bull;
21-
<a href="ARCHITECTURE.md">Architecture</a> &bull;
21+
<a href="docs/contributing/ARCHITECTURE.md">Architecture</a> &bull;
2222
<a href="https://discord.gg/RySmvNF5kF">Discord</a>
2323
</p>
2424

@@ -184,7 +184,7 @@ mode = "failures"
184184

185185
- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - Resoudre les problemes courants
186186
- **[INSTALL.md](INSTALL.md)** - Guide d'installation detaille
187-
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Architecture technique
187+
- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - Architecture technique
188188

189189
## Contribuer
190190

@@ -195,3 +195,7 @@ Rejoignez la communaute sur [Discord](https://discord.gg/RySmvNF5kF).
195195
## Licence
196196

197197
Licence MIT - voir [LICENSE](LICENSE) pour les details.
198+
199+
## Avertissement
200+
201+
Voir [DISCLAIMER.md](DISCLAIMER.md).

README_ja.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<a href="https://www.rtk-ai.app">ウェブサイト</a> &bull;
1919
<a href="#インストール">インストール</a> &bull;
2020
<a href="docs/TROUBLESHOOTING.md">トラブルシューティング</a> &bull;
21-
<a href="ARCHITECTURE.md">アーキテクチャ</a> &bull;
21+
<a href="docs/contributing/ARCHITECTURE.md">アーキテクチャ</a> &bull;
2222
<a href="https://discord.gg/RySmvNF5kF">Discord</a>
2323
</p>
2424

@@ -146,7 +146,7 @@ rtk discover # 見逃した節約機会を発見
146146

147147
- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - よくある問題の解決
148148
- **[INSTALL.md](INSTALL.md)** - 詳細インストールガイド
149-
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 技術アーキテクチャ
149+
- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - 技術アーキテクチャ
150150

151151
## コントリビュート
152152

@@ -157,3 +157,7 @@ rtk discover # 見逃した節約機会を発見
157157
## ライセンス
158158

159159
MIT ライセンス - 詳細は [LICENSE](LICENSE) を参照。
160+
161+
## 免責事項
162+
163+
詳細は [DISCLAIMER.md](DISCLAIMER.md) を参照。

README_ko.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<a href="https://www.rtk-ai.app">웹사이트</a> &bull;
1919
<a href="#설치">설치</a> &bull;
2020
<a href="docs/TROUBLESHOOTING.md">문제 해결</a> &bull;
21-
<a href="ARCHITECTURE.md">아키텍처</a> &bull;
21+
<a href="docs/contributing/ARCHITECTURE.md">아키텍처</a> &bull;
2222
<a href="https://discord.gg/RySmvNF5kF">Discord</a>
2323
</p>
2424

@@ -146,7 +146,7 @@ rtk discover # 놓친 절약 기회 발견
146146

147147
- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - 일반적인 문제 해결
148148
- **[INSTALL.md](INSTALL.md)** - 상세 설치 가이드
149-
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 기술 아키텍처
149+
- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - 기술 아키텍처
150150

151151
## 기여
152152

@@ -157,3 +157,7 @@ rtk discover # 놓친 절약 기회 발견
157157
## 라이선스
158158

159159
MIT 라이선스 - 자세한 내용은 [LICENSE](LICENSE)를 참조하세요.
160+
161+
## 면책 조항
162+
163+
자세한 내용은 [DISCLAIMER.md](DISCLAIMER.md)를 참조하세요.

README_zh.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<a href="https://www.rtk-ai.app">官网</a> &bull;
1919
<a href="#安装">安装</a> &bull;
2020
<a href="docs/TROUBLESHOOTING.md">故障排除</a> &bull;
21-
<a href="ARCHITECTURE.md">架构</a> &bull;
21+
<a href="docs/contributing/ARCHITECTURE.md">架构</a> &bull;
2222
<a href="https://discord.gg/RySmvNF5kF">Discord</a>
2323
</p>
2424

@@ -154,7 +154,7 @@ rtk discover # 发现遗漏的节省机会
154154

155155
- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - 解决常见问题
156156
- **[INSTALL.md](INSTALL.md)** - 详细安装指南
157-
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 技术架构
157+
- **[ARCHITECTURE.md](docs/contributing/ARCHITECTURE.md)** - 技术架构
158158

159159
## 贡献
160160

@@ -165,3 +165,7 @@ rtk discover # 发现遗漏的节省机会
165165
## 许可证
166166

167167
MIT 许可证 - 详见 [LICENSE](LICENSE)
168+
169+
## 免责声明
170+
171+
详见 [DISCLAIMER.md](DISCLAIMER.md)

0 commit comments

Comments
 (0)