Language standards

Language Standards for Code and Documentation

Overview

This document outlines the language requirements for various elements within our repositories and documentation platforms. Adhering to these guidelines ensures consistency and clarity across all our technical resources.

Language Guidelines

1. Repository Content

2. All source code, comments, README files, and any other content stored within repositories must be in English.

3. Pull Requests

4. Titles, descriptions, and other metadata associated with Pull Requests (PRs) must be in English.

5. Code Reviews

6. Comments made during code reviews can be in either Spanish or English, allowing flexibility depending on the reviewer’s preference and the context of the review.

7. Technical Documentation

8. All technical documentation hosted on Confluence or any other documentation platform must be exclusively in English.

Tool Recommendation

To enhance the quality of our documentation and written communication, we recommend using the AI-driven language model, ChatGPT. This tool can assist in refining text to meet professional technical writing standards. It is particularly useful for finalizing the text in documentation, PR descriptions, and code comments.

Reference

For specific coding standards in Flutter, refer to our detailed guide: Flutter Code Conventions.