Skip to content

Instruct agents to create a repo root alias #10165

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
auto-submit merged 2 commits into from
Oct 3, 2025
Merged

Instruct agents to create a repo root alias #10165

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f4b3e8
Instruct agents to create a repo root alias
stuartmorgan-g Oct 3, 2025
8051f86
Change terminology
stuartmorgan-g Oct 3, 2025
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
11 changes: 8 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,15 @@ The primary tool for this repository is `flutter_plugin_tools.dart`.

### Initial Setup

First, initialize the tooling:
First, define an alias for the repository root directory and initialize the tooling:
```bash
cd $REPO_ROOT/script/tool # $REPO_ROOT is the repository root
dart pub get
# Define an alias for the repository root.

@gemini-code-assist gemini-code-assist Bot Oct 3, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

For improved accuracy, it's better to call REPO_ROOT an 'environment variable' instead of an 'alias'. In shell scripting, an alias is a shortcut for a command, whereas export creates an environment variable that holds a value. This change updates the terminology in both the description and the code comment for correctness.

Suggested change
First, define an alias for the repository root directory and initialize the tooling:
```bash
cd $REPO_ROOT/script/tool # $REPO_ROOT is the repository root
dart pub get
# Define an alias for the repository root.
First, define an environment variable for the repository root directory and initialize the tooling:
```bash
# Define an environment variable for the repository root.

@stuartmorgan-g stuartmorgan-g Oct 3, 2025

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Entertainingly, the use of "alias" came from Gemini in the first place 🤷🏻 I left it alone before because it was a Gemini suggestion, so I was trusting the model, but it seems like maybe it was a quirk of my prompt rather than a model preference so I've changed it to be accurate.

export REPO_ROOT=$(pwd)

# Verify that the alias is working correctly.
echo "Repository root directory: $REPO_ROOT"

dart pub get -C $REPO_ROOT/script/tool
```

### Identifying Target Packages
Expand Down
2 changes: 1 addition & 1 deletion script/tool/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ local development.
Set up:

```sh
cd script/tool && dart pub get && cd ../../
dart pub get -C script/tool
```

Run:
Expand Down