From bbd737e9bbeafc4bba8cb5a33552129da6f2f7d6 Mon Sep 17 00:00:00 2001 From: Piotr Konopka Date: Thu, 6 Nov 2025 09:59:07 +0100 Subject: [PATCH] Add a copilot guidelines for avoiding unobvious abbreviations and acronyms --- .github/copilot-instructions.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index afa8b0e1..fb701143 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -14,4 +14,5 @@ It is a distributed system that combines state of the art cluster resource manag - Do not include modified go.mod and go.sum files in your commits unless you are adding or upgrading a dependency. - When adding features or fixing bugs, add a corresponding unit test if feasible. Use Ginkgo/Gomega, unless a package already uses a different testing framework. - When adding a new feature, extend the documentation accordingly, follow the existing style and structure, and make sure that Tables of Contents are updated. See [Documentation guidelines](docs/CONTRIBUTING.md#documentation-guidelines) for some more details. -- When providing a fix, explain what was causing the issue and how it was fixed. \ No newline at end of file +- When providing a fix, explain what was causing the issue and how it was fixed. +- Avoid using abbreviations and acronyms for variable and function names. They are acceptable if they are commonly used in a given domain, such as "cfg" for "configura +++tion" or "LHC" for "Large Hadron Collider".