Skip to content

Commit e4530c9

Browse files
committed
add(repo): ci badge, dependabot, and contributing guide
1 parent 5323b7f commit e4530c9

3 files changed

Lines changed: 66 additions & 0 deletions

File tree

.github/dependabot.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "swift"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing to AgentRunKit
2+
3+
Thanks for your interest in contributing.
4+
5+
## Setup
6+
7+
```bash
8+
# Install tools
9+
make bootstrap
10+
11+
# Verify everything works
12+
make check
13+
```
14+
15+
`make bootstrap` installs [Mint](https://github.com/yonaskolb/Mint) and the pinned versions of SwiftFormat and SwiftLint from the `Mintfile`.
16+
17+
## Before Submitting a PR
18+
19+
Run the full gate:
20+
21+
```bash
22+
make check
23+
```
24+
25+
This runs `swiftformat`, `swiftlint --strict`, and `swift test`. CI runs the same checks — if `make check` passes locally, CI will pass.
26+
27+
## Code Style
28+
29+
- SwiftFormat and SwiftLint enforce the style. Don't fight the tools.
30+
- No comments or docstrings unless explaining a non-obvious *why*.
31+
- No backward-compatibility hacks. Prefer the most elegant solution.
32+
- All public types must be `Sendable`.
33+
34+
See `CLAUDE.md` for the full coding standards.
35+
36+
## Commit Messages
37+
38+
Format: `verb(scope): description`
39+
40+
```
41+
add(gemini): google gemini client with streaming and tool calling
42+
fix(auth): prevent token refresh race on concurrent requests
43+
refactor(api): extract shared validation into middleware
44+
```
45+
46+
Single sentence, lowercase, imperative mood, no trailing period.
47+
48+
## Tests
49+
50+
Every change needs tests. Test behavior, not implementation details. Run with:
51+
52+
```bash
53+
swift test --filter YourTestSuite
54+
```

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
</p>
66

77
<p align="center">
8+
<a href="https://github.com/Tom-Ryder/AgentRunKit/actions/workflows/ci.yml"><img src="https://github.com/Tom-Ryder/AgentRunKit/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
89
<img src="https://img.shields.io/badge/Swift-6.0-orange" alt="Swift 6.0">
910
<img src="https://img.shields.io/badge/Platforms-iOS%2018%20%7C%20macOS%2015-blue" alt="Platforms">
1011
<img src="https://img.shields.io/badge/On--Device-MLX%20%7C%20Foundation%20Models-8B5CF6" alt="On-Device MLX + Foundation Models">

0 commit comments

Comments
 (0)