From 9ed045ec25f48d22cfb74709c7fecd341a366aba Mon Sep 17 00:00:00 2001 From: Dana Jansens Date: Sat, 28 Mar 2026 02:21:14 -0400 Subject: [PATCH] Add a link to the docs on testing the toolchain to CONTRIBUTING.md (#6981) It takes a bit of work to track down instructions on running file tests and autoupdate. Add a link to them directly from CONTRIBUTING.md, since all searches start there. --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51ab500d0102..e43ae049a0ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,6 +33,7 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception - [Style](#style) - [Google Docs and Markdown](#google-docs-and-markdown) - [Other files](#other-files) +- [Testing](#testing) - [License](#license) - [Google Docs](#google-docs) - [Markdown](#markdown) @@ -308,7 +309,6 @@ follow the Carbon documentation and coding styles. request. - For code: - - New features should have a documented design that has been approved through the [evolution process](docs/project/evolution.md). This includes modifications to preexisting designs. @@ -427,6 +427,14 @@ Other style points to be aware of are: If you're not sure what style to use, please ask on Discord or GitHub. +## Testing + +Most development in the Carbon project is on the [toolchain](toolchain/). The +toolchain contains some unit tests, but the majority of testing is done through +`file_test` tests, which test the output of the different phases of the +toolchain. The toolchain docs include instructions for +[building and running tests](toolchain/docs/adding_features.md#tests-and-debugging). + ## License A license is required at the top of all documents and files.