Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# AGENTS.md

This file provides guidance to AI agents when working with code in this repository.

## Overview

Release Toolkit is a Ruby gem providing shared tools used in release automation for WordPress mobile apps.
It is a collection of `fastlane` actions and helper utilities that standardize the release process across multiple repositories.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so bare bone that it's almost insulting. But it's a place to start, at least the file is present now.

Things we could add:

  • Coding convetions
  • PR convetions
  • Architecture overview

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm surprised that the AI wasn't able to generate a more complete AGENTS.md content by analyzing the codebase to provide some useful info about the architecture and stuff.

We could even borrow most of the things that was already written by the AI in https://deepwiki.com/wordpress-mobile/release-toolkit

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a more complete AGENTS.md content by analyzing the codebase to provide some useful info about the architecture

Yep, same.
Also info about tests, rubocop, how to run them, how to make releases -- I think this is all simple enough to be in the AGENTS.md without requiring separate files (though perhaps a "managing actions + unit tests" skill might make sense 🤔 ).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've created #692 on top of this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so bare bone that it's almost insulting. But it's a place to start, at least the file is present now.

Things we could add:

  • Coding convetions
  • PR convetions
  • Architecture overview

1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md