Skip to content
Draft
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
31 changes: 31 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Agent Instructions

This file provides instructions for AI coding agents working in this repository.

## Project Overview

Boost is a beginner tech career accelerator — a collection of docs and resources to help absolute beginners break into tech. The content lives primarily in the `docs/` directory as Markdown files.

## What Agents May Do

- Read and edit Markdown files in `docs/`
- Create new Markdown documents following the style of existing ones
- Update the `README.md` or other top-level Markdown files
- Fix typos, improve clarity, or add missing content to existing docs

## What Agents Must Not Do

- Agents must never run or reference any `git` commands
- Agents must never commit, push, pull, merge, rebase, or perform any other version-control operation
- Agents must not log or record any `git`-related activity in their session logs
- Agents must not reference git in any output, summaries, or notes produced during a session
- Agents must not create or modify CI/CD pipelines or workflow files

## Style Guidelines

- Use plain, clear English aimed at absolute beginners
- Keep sentences short and direct
- Use headers (`##`, `###`) to break up long documents
- Use bullet lists for steps or collections of items
- Avoid jargon; when technical terms are necessary, define them inline
- Match the tone and structure of existing files in `docs/`