# ADR-0009 - Use American English

## Status

- ACCEPTED on 2025-11-24

## Context

Gradle is an international open-source project with contributors from around the world. English is the primary language for code, comments, documentation, and communication, but there are variations in English spelling and terminology, specifically American English vs. British English.

Inconsistency in spelling conventions can lead to several issues:

Translate an English original content to a target language.

The original content is written in Markdown, write the translation in Markdown as well.

The original content will be surrounded by triple percentage signs (%%%). Do not include the triple percentage signs in the translation.

### Technical terms in English

For technical terms in English that don't have a common translation term, use the original term in English.

		}
	}
}

func TestParseTagSettingWithDoubleQuoteEscape(t *testing.T) {
	tag := `gorm:"expression:to_tsvector('english', \"Name\")"`
	settings := ParseTagSetting(reflect.StructTag(tag).Get("gorm"), ";")
	if v, ok := settings["EXPRESSION"]; !ok || v != `to_tsvector('english', "Name")` {
		t.Errorf("ParseTagSetting did not handle escaped double quotes correctly: got %#v", v)
	}

- If a heading contains only the name of a FastAPI feature, do not translate it.

### Quotes and punctuation

- Keep punctuation style consistent with existing Simplified Chinese docs (they often mix English terms like “FastAPI” with Chinese text).
- Never change punctuation inside inline code, code blocks, URLs, or file paths.

### Ellipsis

- Keep ellipsis style consistent within each document, prefer `...` over  `……`.

- path operation: 路徑操作
- path operation function: 路徑操作函式

The translation can optionally include the original English text only in the first occurrence of each page (e.g. "路徑操作 (path operation)") if the translation is hard to be comprehended by most of the Chinese readers.

### `///` admonitions

1) Keep the admonition keyword in English (do not translate `note`, `tip`, etc.).

Currently supported UI languages: German, English, Spanish, French, Italian, Japanese, Korean, Dutch, Polish, Brazilian Portuguese, Russian, Simplified Chinese, and Traditional Chinese.

## File Structure

Language resource files are located in:
```
src/main/resources/
├── fess_label.properties           # Base English labels (fallback)

        return super.godHandPrologue(runtime);
    }

    /**
     * Converts validation messages to a localized string representation for API responses.
     * Uses the request locale if available, otherwise defaults to English.
     *
     * @param validationMessagesLambda lambda function that adds validation messages
     * @return concatenated string of localized validation messages separated by spaces
     */

def process_one_page(path: Path) -> bool:
    """
    Fix one translated document by comparing it to the English version.

    Returns True if processed successfully, False otherwise.
    """

    try:
        lang_code = path.parts[1]
        if lang_code == "en":
            print(f"Skipping English document: {path}")
            return True

        en_doc_path = Path("docs") / "en" / Path(*path.parts[2:])

It could have mistakes of misunderstanding the original meaning, or looking unnatural, etc. 🤖

You can improve this translation by [helping us guide the AI LLM better](https://fastapi.tiangolo.com/contributing/#translations).

[English version](ENGLISH_VERSION_URL)

- request (HTTP): リクエスト
- response (HTTP): レスポンス
- path operation: path operation (do not translate)

### `///` admonitions

1) Keep the admonition keyword in English (do not translate `note`, `tip`, etc.).
2) If a title is present, prefer these canonical titles:

- `/// note | 備考`
- `/// note | 技術詳細`
- `/// tip | 豆知識`
- `/// warning | 注意`
- `/// info | 情報`
- `/// check | 確認`