Skip to content

Add common pitfalls and quick start to AGENTS.md #699

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

Open
mokagio wants to merge 3 commits into
base: trunk
Choose a base branch
from
Open

Add common pitfalls and quick start to AGENTS.md #699

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c0dc92
Add common pitfalls to `AGENTS.md`
mokagio Feb 26, 2026
ae41e5e
Ignore the whole of `vendor/` not just `vendor/bundle/`
mokagio Feb 26, 2026
b4f4a2d
Remove `gem build` from quickstart
mokagio Feb 26, 2026
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
10 changes: 10 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ Release Toolkit is a _fastlane_ plugin implemented as a Ruby gem (`fastlane-plu
- **Main branch**: `trunk`
- **Gem version**: defined in `lib/fastlane/plugin/wpmreleasetoolkit/version.rb`

## Quick Start

```sh
bundle install && bundle exec rubocop && bundle exec rspec
```

## Build and Development Commands

```sh
Expand Down Expand Up @@ -215,3 +221,7 @@ Runtime and development dependencies with version constraints are defined in `fa
- **gettext** — i18n/PO files
- **google-cloud-storage** — GCS uploads
- **buildkit** — Buildkite API

## Common Pitfalls

- **Don't inspect or edit `vendor/` unless necessary** — The bundled gems and SwiftGen binaries live there.