mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 20:20:10 +01:00
Jon Ross-Perkins
6b2d55d289
Trying to work on some behaviors: - Using `black` to format Python files (using `pre-commit` makes better use of allow-listed commands) - Writing Python code over 80 columns (adding more style notes) - Running `bazel` (being more emphatic about `bazelisk`, splitting tool usage out to its own skill to try making clear it's not toolchain-specific) Assisted-by: Google Antigravity with Gemini
52 lines
1.8 KiB
Markdown
52 lines
1.8 KiB
Markdown
# Gemini & AI assistant guide for Carbon
|
|
|
|
<!--
|
|
Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
Exceptions. See /LICENSE for license information.
|
|
SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
-->
|
|
|
|
This document provides high-density technical context for AI assistants (and
|
|
humans!) contributing to the Carbon Language project. If you are an AI
|
|
assistant, **read this first** to avoid common pitfalls.
|
|
|
|
## Table of contents
|
|
|
|
- [General instructions](#general-instructions)
|
|
- [Project structure](#project-structure)
|
|
- [Toolchain development](#toolchain-development)
|
|
|
|
## General instructions
|
|
|
|
- **Communication**: Be concise, professional, and technical. Use GitHub-style
|
|
markdown.
|
|
- **Verification**: Always run relevant tests.
|
|
- **Tool usage**: Use web search for any research outside the immediate
|
|
codebase or KIs.
|
|
|
|
## Project structure
|
|
|
|
- **[`common/`](common/)**: Common C++ utilities used across the project.
|
|
- **[`core/`](core/)**: The Carbon standard library (Core).
|
|
- **[`docs/`](docs/)**: Project documentation, design, and style guides.
|
|
- **[`examples/`](examples/)**: Example Carbon programs and code snippets.
|
|
- **[`proposals/`](proposals/)**: Evolution proposals.
|
|
- **[`testing/`](testing/)**: Testing utilities and infrastructure.
|
|
- **[`toolchain/`](toolchain/)**: The C++ implementation of the compiler
|
|
(Toolchain).
|
|
|
|
## Tool usage
|
|
|
|
See the "Tool usage" skill for instructions on what tools to use in the
|
|
carbon-lang project.
|
|
|
|
## Code style
|
|
|
|
See the "Code style" skill for instructions on formatting, style guides, and
|
|
code conventions to follow.
|
|
|
|
## Toolchain development
|
|
|
|
See the "Toolchain Development" skill for instructions on architecture,
|
|
building, testing, debugging, C++ patterns, and common pitfalls.
|