> For the complete documentation index, see [llms.txt](https://docs.civictheme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.civictheme.io/development/maintenance/code-naming-conventions.md).

# Code naming conventions

{% hint style="info" %}
Requirement levels (MUST, SHOULD, MAY) are used in accordance with [RFC2119](https://www.ietf.org/rfc/rfc2119.txt)
{% endhint %}

* Configuration **MUST** be stored in the `civictheme` theme's `config/install` and `config/optional` directories.
* All machine names **MUST** be prefixed with `civictheme_` for:
  * Content types
  * Vocabularies
  * Text formats
  * User roles
* UI **MUST NOT** refer to `CivicTheme` .
* `page` or `article` **SHOULD NOT** be used as a prefix for the name of a content type unless absolutely necessary, instead: `News article` , `Blog page`
* Field names **MUST** be:
  * Prefixed with `field_c_<first_letter_of_entity_type>_`
  * Given generic names based on their purpose and SHOULD be shared across multiple bundles
  * Named using singular nouns
* Vocabularies **MUST** be:
  * Named using plural nouns
  * Named using contextual information to distinguish between vocabularies used for specific purposes: `Blog topics` instead of just `Topics`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.civictheme.io/development/maintenance/code-naming-conventions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.