Skip to content
Open
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
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,15 @@ test: add coverage for recipe validation

## Code Style

- **Python**: Follow existing code conventions. Pre-commit hooks enforce
formatting.
- **Python**: We use [`ruff`](https://docs.astral.sh/ruff/) for formatting and
linting. Run `uv run ruff check .` to check your code and `uv run ruff format .`
to auto-fix formatting issues before committing. Pre-commit hooks enforce
these checks.
- **Markdown**: Follow
[markdownlint](https://github.com/DavidAnson/markdownlint) rules (see
`.markdownlint.json`).
- Keep functions focused and well-documented.
`.markdownlint.json`). Run `uv run markdownlint docs/` to check.
- Keep functions focused and well-documented — aim for functions under 50 lines
with a docstring explaining purpose, args, and return value.

## Pull Request Guidelines

Expand Down
2 changes: 1 addition & 1 deletion docs/PREREQUISITES.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The amplihack framework requires the following tools. Each entry explains **what
| **npm** | (with Node.js) | Node.js package manager | Installs Claude CLI |
| **uv** | latest | Fast Python package installer | Installs amplihack itself and its Python dependencies |
| **git** | 2.0+ | Version control | Branch management, PRs, and workflow automation |
| **claude** | latest | Claude Code CLI | Core AI coding assistant that amplihack extends |
| **claude** | latest | [Claude Code CLI](https://docs.anthropic.com/enfo/docs/claude_code/overview) — run via `amplihack claude` after install via `npm install -g @anthropic-ai/claude-code` | Core AI coding assistant that amplihack extends |
| **cargo** | 1.70+ | Rust package manager | Installs the Rust recipe runner for fast recipe execution. Install via [rustup.rs](https://rustup.rs/) |

## Quick Check
Expand Down
Loading