Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (12 loc) · 679 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (12 loc) · 679 Bytes

Contributing to AgentRunKit

Thanks for your interest in contributing.

Setup

make bootstrap
make check

make bootstrap installs Mint and the pinned versions of SwiftFormat and SwiftLint from the Mintfile. make check runs formatting, linting, and tests.

Documentation

New public API must include /// doc comments (one sentence, period). If the feature adds a new concept or workflow, add or update an article in Sources/AgentRunKit/Documentation.docc/Articles/. Run make docs to verify the DocC build produces zero warnings.

Before Submitting a PR

Run make check. If it passes locally, CI will pass.