X-Git-Url: https://git.giacomolli.uk/onechat/blobdiff_plain/80fa33c0fd65e4110f88f0cab9b19ca26c27d1f6..53c6c8a5a17e2dfc8bd3ff02ab99d29d709dda2f:/.agents/skills/go-code/SKILL.md diff --git a/.agents/skills/go-code/SKILL.md b/.agents/skills/go-code/SKILL.md index 7de0a40..3d9e3f3 100644 --- a/.agents/skills/go-code/SKILL.md +++ b/.agents/skills/go-code/SKILL.md @@ -13,6 +13,16 @@ description: Go style rules. Use before you write or review Go code. function. Do not create `main_test.go`. - A file carries its own context. Keep each struct and all of its methods in one file. Give a separate responsibility its own type. +- When code in one file gets a user in another file for an unrelated + purpose, move it to a file named for its function in the same change. +- Start each package-level name that belongs to one feature or + integration with the name of that feature. Start the names of its + files with the same name. Keep a name generic only when more than one + feature uses it. +- Write type names with a capital letter, so that a variable can have + the name of its type. Write all other package-level names in lower + case. +- Write all the letters of an initialism in one case. - Put entry points first, then each struct's methods as a group, then standalone utility functions. Do not put a utility function between the methods of one type. @@ -50,8 +60,11 @@ description: Go style rules. Use before you write or review Go code. test callbacks. - Do not use short `if` initializers. - Use a one-letter receiver name for each method. -- Put each field of a keyed struct literal on its own line when you set - more than one field. +- Use field names in struct literals. Put each field on its own line + when you set more than one field. This includes the cases of a + table-driven test. A small type of two fields that acts as one value, + such as a key or a coordinate pair, can use a positional literal on + one line. - Put an empty line between logical blocks, also after multiline declarations, assignments, literals, and calls. Keep an operation with its immediate error or result check. Keep a short declaration with its @@ -79,5 +92,8 @@ description: Go style rules. Use before you write or review Go code. input. - In a test file, put constants immediately after the imports, then the tests, then supporting types, methods, and helpers. +- Keep a helper that only one test file uses in that file. Put a helper + that more than one test file uses in a file without tests. Name that + file for what it holds, and end the name with `_helper_test.go`. - Supply valid required dependencies in tests. Do not make a dependency optional only to make a test simpler.