Skip to content

Commit a6baec4

Browse files
committed
docs: add project language requirement to ensure consistency in code and documentation
1 parent 7800f67 commit a6baec4

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

.github/copilot-instructions.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,15 @@ RobotCode is a comprehensive Robot Framework toolkit that provides IDE extension
9393
- **README Files:** Each package/module should have clear usage documentation
9494
- **Inline Comments:** Explain *why*, not *what* - the code should be self-documenting
9595

96+
### Project Language Requirement
97+
- **English for code and docs (REQUIRED):** Regardless of the natural language a user speaks when interacting with contributors or tools, all project-facing text must use English. This includes:
98+
- Documentation and README content
99+
- Inline comments and docstrings
100+
- Public and internal variable, function, class, and module names (identifiers)
101+
- Commit messages and code review comments where project conventions apply
102+
103+
This rule ensures consistency across the codebase, improves discoverability for international contributors, and enables reliable tooling (linters, analyzers, and internationalized docs). Use English even when writing examples or user-facing strings in tests; if localised strings are required, keep the canonical code-level names and primary docs in English and add separate localized resources.
104+
96105
### Testing Requirements
97106
- **Test Coverage:** Maintain high test coverage with meaningful test cases
98107
- **Test Naming:** Use descriptive test names that explain the scenario

0 commit comments

Comments
 (0)