Skip to content

Add AGENTS contributor guidelines #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vanities merged 1 commit into from
Jul 12, 2025
Merged

Add AGENTS contributor guidelines #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributor Guidelines

This repository is an iOS app written in SwiftUI. It uses CocoaPods and Fastlane for dependency and build management. The project depends on MobileVLCKit (the VLCKit CocoaPods distribution) for media playback.

## Setup

1. Install Ruby gems with `bundle install`.
2. Install iOS dependencies with `pod install` and open `swiftchan.xcworkspace`.
3. SwiftLint is included via CocoaPods. Run `Pods/SwiftLint/swiftlint autocorrect && Pods/SwiftLint/swiftlint` before committing.
4. Tests can be executed with `bundle exec fastlane tests` (requires macOS/Xcode). If Xcode isn't available, mention this in your PR summary.

## Contribution

- Follow the style enforced by SwiftLint and the existing `.swiftlint.yml` file.
- Ensure builds succeed and existing tests pass after your changes.
- MobileVLCKit is referenced from the Podfile; consult VLCKit documentation when modifying video playback logic.
- Use Pull Requests for changes. Keep commit messages concise.
Loading