Add AGENTS.md by desmondwong1215 · Pull Request #249 · git-mastery/exercises

desmondwong1215 · 2026-01-26T13:35:12Z

Adds skills with AI-optimized documentation following Agent Skills standard.

Structure:

4 skill areas: project-overview, exercise-development, exercise-utils, coding-standards
AGENTS.md is the entry point that guides AI to load relevant skills per task
Documentation references actual code files vs duplicating examples
Usage: AI agents read AGENTS.md, identify needed skills, and load only what's relevant.

github-actions · 2026-01-26T13:35:29Z

Hi @desmondwong1215, thank you for your contribution! 🎉

This PR comes from your fork desmondwong1215/exercises on branch agent.

Before you request for a review, please ensure that you have tested your changes locally!

Important

The previously recommended way of using ./test-download.py is no longer the best way to test your changes locally.

Please read the following instructions for the latest instructions.

Prerequisites

Ensure that you have the gitmastery app installed locally (instructions)

Testing steps

If you already have a local Git-Mastery root to test, you can skip the following step.

Create a Git-Mastery root locally:

gitmastery setup

Navigate into the Git-Mastery root (defaults to gitmastery-exercises/):

cd gitmastery-exercises/

Edit the .gitmastery.json configuration file. You need to set the following values under the exercises_source key.

{
    # other fields...
    "exercises_source": {
        "username": "desmondwong1215",
        "repository": "exercises",
        "branch": "agent"
    }
}

Then, you can use the gitmastery app to download and verify your changes locally.

gitmastery download <your new change>
gitmastery verify

Checklist

(For exercises and hands-ons) I have verified that the downloading behavior works
(For exercises only) I have verified that the verification behavior is accurate

Important

To any reviewers of this pull request, please use the same instructions above to test the changes.

Copilot

Pull request overview

This PR introduces an AI-facing documentation layer using the “Agent Skills” pattern, plus an AGENT.md entrypoint, to help AI tools and humans navigate and extend the Git-Mastery exercises repo.

Changes:

Adds AGENT.md describing how AI agents should load and combine skills for different tasks.
Introduces structured skills under .claude/skills/ for project overview, exercise development, exercise utilities, and coding standards, including detailed sub-guides.
Documents the exercise_utils APIs and common exercise/test patterns, with links into real code and example exercises.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
`AGENT.md`	Defines the top-level AI agent workflow and maps user tasks to the new skills.
`.claude/skills/project-overview/SKILL.md`	Provides a high-level repo overview, exercise types, conventions, and links to other skills (some links currently point to missing docs/skills).
`.claude/skills/exercise-utils/SKILL.md`	Central index and quick-reference for the `exercise_utils` package, with examples and module dependency diagram (testing skill link is broken).
`.claude/skills/exercise-utils/git-module.md`	Documents the `exercise_utils.git` wrapper functions and their responsibilities.
`.claude/skills/exercise-utils/github-module.md`	Documents `exercise_utils.github_cli` helpers, but currently shows an incorrect `clone_repo_with_gh` signature.
`.claude/skills/exercise-utils/cli-module.md`	Describes the CLI execution helpers (`run`, `run_command`, `run_command_no_exit`) and where they’re used.
`.claude/skills/exercise-utils/file-module.md`	Documents file utility helpers and how they auto-create directories/dedent content.
`.claude/skills/exercise-utils/gitmastery-module.md`	Describes `create_start_tag()` and when to use it versus test helpers.
`.claude/skills/exercise-utils/test-module.md`	Summarizes the test loader and helpers, but shows an incorrect `GitAutograderStatus.SUCCESS` enum in the example.
`.claude/skills/exercise-development/SKILL.md`	Top-level guide for creating/modifying exercises, but its contract for standard exercises (download.py with `__requires_*__` and `download()`) is out of sync with current tooling (`.gitmastery-exercise.json` + `setup()`), references a non-existent `remote_branch_pull/` exercise, and links to a missing `testing` skill.
`.claude/skills/exercise-development/standard-exercises.md`	Deep-dive guide for standard exercises, including scaffolding, patterns, and testing; shares the same outdated assumptions about `download.py` entrypoints/flags.
`.claude/skills/exercise-development/hands-on-scripts.md`	Detailed guide for creating hands-on scripts, aligned with current `hands_on/*` patterns and `scripts/test-download.py`.
`.claude/skills/coding-standards/SKILL.md`	Captures style, naming, type-hint, and best-practice guidance, but also links to a non-existent `testing` skill.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.claude/skills/exercise-utils/github-module.md

.claude/skills/exercise-development/SKILL.md

.claude/skills/project-overview/SKILL.md

.claude/skills/exercise-utils/SKILL.md

.claude/skills/coding-standards/SKILL.md

.claude/skills/exercise-development/SKILL.md

.claude/skills/exercise-utils/test-module.md

.claude/skills/project-overview/SKILL.md

VikramGoyal23 · 2026-01-27T05:06:31Z

@desmondwong1215 Please rename AGENT.md to AGENTS.md

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 13 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

AGENTS.md

.claude/skills/exercise-development/SKILL.md

.claude/skills/exercise-development/standard-exercises.md

.claude/skills/exercise-utils/file-module.md

.claude/skills/exercise-utils/test-module.md

.claude/skills/exercise-utils/gitmastery-module.md

.claude/skills/exercise-utils/github-module.md

.claude/skills/exercise-utils/git-module.md

.claude/skills/exercise-utils/cli-module.md

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.claude/skills/exercise-development/standard-exercises.md

.claude/skills/exercise-utils/git-module.md

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.claude/skills/exercise-development/standard-exercises.md

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.claude/skills/project-overview/SKILL.md

.claude/skills/coding-standards/SKILL.md

jovnc · 2026-01-30T06:46:10Z

.claude/skills/coding-standards/SKILL.md

+- **Constants at top**: Module-level `UPPER_CASE`
+
+## Common Mistakes to Avoid
+- ❌ Calling `git` directly instead of using exercise_utils/git.py


Should we remove emojis from these files? Seems to be additional tokens to the context

jovnc · 2026-01-30T06:47:09Z

.claude/skills/exercise-development/hands-on-scripts.md

+
+### 1. Create Script File
+
+Simply create a new `.py` file in the `hands_on/` directory:


While this is not entirely wrong, we can also use the new.sh script to generate a new hands on, which do you think is better?

I think it is better to follow the standard workflow.

jovnc · 2026-01-30T06:49:00Z

.claude/skills/project-overview/SKILL.md

I think this skill can be omitted, doesn't seem to be a "skill" for the agent

jovnc · 2026-01-30T06:49:35Z

.claude/skills/coding-standards/SKILL.md

I think this shouldnt be a "skill" for the agent, it should come under AGENTS.md directly, it is more of an instruction to the agent rather than a specific "skill"

jovnc · 2026-01-30T06:50:18Z

AGENTS.md

+- **Using utilities?** → `exercise-utils` (standalone)
+- **Code review?** → `coding-standards` (standalone)
+
+## For Human Developers


No need to include this in AGENTS.md, it should be solely for AI context, not human developers

jovnc

LGTM let's merge this in and see if it helps, can always revert as its non-critical as well

desmondwong1215 added 7 commits January 26, 2026 19:19

Add AGENT.md

5eca7d9

Add coding-standards skill

868cb54

Add coding-standards skill

2833de8

Add skills for AI agent

7f59981

Remove unnecessary file

146fe4b

Update AGENT.md

5d862c0

Address review

43ef4e5

desmondwong1215 requested a review from Copilot January 26, 2026 13:35

Copilot started reviewing on behalf of desmondwong1215 January 26, 2026 13:35 View session

Copilot AI reviewed Jan 26, 2026

View reviewed changes

desmondwong1215 marked this pull request as draft January 26, 2026 15:09

desmondwong1215 added 2 commits January 27, 2026 13:07

Address copilot comment

0a358c7

Rename AGENTS.md

e27032b

desmondwong1215 requested a review from Copilot January 27, 2026 05:10

Copilot started reviewing on behalf of desmondwong1215 January 27, 2026 05:10 View session

Remove AGENT.md

055e2d9

Copilot AI reviewed Jan 27, 2026

View reviewed changes

desmondwong1215 added 2 commits January 27, 2026 13:29

Address Copilot Comment

bf5d5b2

Change python version

933985e

desmondwong1215 requested a review from Copilot January 27, 2026 05:41

Copilot started reviewing on behalf of desmondwong1215 January 27, 2026 05:42 View session

Copilot AI reviewed Jan 27, 2026

View reviewed changes

.claude/skills/exercise-development/standard-exercises.md Outdated Show resolved Hide resolved

.claude/skills/exercise-utils/git-module.md Outdated Show resolved Hide resolved

Address copilot comment

98f0a25

desmondwong1215 changed the title ~~Add Agent.md~~ Add ADENTS.md Jan 27, 2026

desmondwong1215 requested a review from Copilot January 27, 2026 06:46

Copilot started reviewing on behalf of desmondwong1215 January 27, 2026 06:46 View session

Copilot AI reviewed Jan 27, 2026

View reviewed changes

.claude/skills/exercise-development/standard-exercises.md Outdated Show resolved Hide resolved

.claude/skills/exercise-development/standard-exercises.md Outdated Show resolved Hide resolved

Address copilot comment

23422bc

desmondwong1215 marked this pull request as ready for review January 27, 2026 06:56

damithc changed the title ~~Add ADENTS.md~~ Add AGENTS.md Jan 27, 2026

desmondwong1215 marked this pull request as draft January 28, 2026 11:39

desmondwong1215 added 2 commits January 28, 2026 20:48

Replace example with link

5d8b42c

Improve consistency

84fdb10

desmondwong1215 requested a review from Copilot January 28, 2026 13:28

Copilot started reviewing on behalf of desmondwong1215 January 28, 2026 13:29 View session

Copilot AI reviewed Jan 28, 2026

View reviewed changes

.claude/skills/project-overview/SKILL.md Outdated Show resolved Hide resolved

.claude/skills/coding-standards/SKILL.md Outdated Show resolved Hide resolved

Change to snake_case

8b95325

desmondwong1215 marked this pull request as ready for review January 28, 2026 13:42

jovnc requested changes Jan 30, 2026

View reviewed changes

Remove coding and overview skill

eef3db2

jovnc approved these changes Feb 4, 2026

View reviewed changes

jovnc merged commit d085c7b into git-mastery:main Feb 4, 2026
4 checks passed

desmondwong1215 deleted the agent branch February 9, 2026 01:29


		### 1. Create Script File

		Simply create a new `.py` file in the `hands_on/` directory:

Conversation

desmondwong1215 commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 26, 2026

Prerequisites

Testing steps

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

VikramGoyal23 commented Jan 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

jovnc Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

jovnc Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

desmondwong1215 Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

jovnc Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

jovnc Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

jovnc Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

jovnc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

desmondwong1215 commented Jan 26, 2026 •

edited

Loading