Skip to content

Commit fee4e34

Browse files
committed
Add a copilot guidelines for avoiding unobvious abbreviations and acronyms
1 parent 20f3a93 commit fee4e34

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

.github/copilot-instructions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ It is a distributed system that combines state of the art cluster resource manag
1414
- Do not include modified go.mod and go.sum files in your commits unless you are adding or upgrading a dependency.
1515
- 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.
1616
- 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.
17-
- When providing a fix, explain what was causing the issue and how it was fixed.
17+
- When providing a fix, explain what was causing the issue and how it was fixed.
18+
- 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".

0 commit comments

Comments
 (0)