Code style
DevelopmentCode style is an Agent Skill for development published in the carbon-language/carbon-lang repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Instructions for code formatting and style guidelines in the Carbon toolchain.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/carbon-language/carbon-lang/blob/HEAD/.agents/skills/code_style/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/code-style, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Code style
License
- Licenses: All Carbon files outside of
third_party/should have a license following CONTRIBUTING license instructions.
Formatting
- Bazel: Use
pre-commit run buildifier --files <file.bzl>to format Bazel files. - C++: Use
pre-commit run clang-format --files <file.cpp>to format C++ files. - Carbon: The toolchain's
formatcommand doesn't work well right now. Instead, try to format Carbon code based on other Carbon files and the C++ style. - Markdown: Use
pre-commit run prettier --files <file.md>to format markdown files. - Python: Use
pre-commit run black --files <file.py>to format Python files.
Style Guides
- C++ style: Follow the Carbon C++ Project Style Guide.
- Markdown style: Follow the Google developer documentation style guide.
- Python style: Follow the PEP 8
style guide.
- Wrap code and comments to 80 columns.
- Run
pre-commit run flake8 --files <file.py>to check Python style.