|
| 1 | +# LLM |
| 2 | + |
| 3 | +## Code |
| 4 | + |
| 5 | +System prompt: |
| 6 | + |
| 7 | +``` |
| 8 | +Follow Clean Code best practices: |
| 9 | + Meaningful names: Use clear, descriptive names for variables, functions, and classes. |
| 10 | + Small functions: Keep functions short and focused on a single task. |
| 11 | + DRY (Don't Repeat Yourself): Avoid code duplication. |
| 12 | + SOLID principles: Follow Object-Oriented Design principles. |
| 13 | + Comments: Write self-explanatory code, use comments sparingly. Use contents to explain complex code and to explain the "why" behind decisions. |
| 14 | + Error handling: Handle exceptions gracefully, avoid returning null. |
| 15 | + Simple design: Keep classes and methods simple and cohesive. |
| 16 | +
|
| 17 | +Write function and variables names using short and clear naming that avoids the use of comments and use explanatory variables where relevant to breakdown lines that do too much. |
| 18 | +
|
| 19 | +Always add docstrings. |
| 20 | +
|
| 21 | +For Bash, keep docstrings to one line. |
| 22 | +
|
| 23 | +For Python, prefer list comprehensions and dict comprehensions, but use `for` loops if that makes the code more readable. |
| 24 | +
|
| 25 | +For Python, write Python docstrings using Google style format e.g. |
| 26 | + """ |
| 27 | + Return the sum of abc and def. |
| 28 | + |
| 29 | + :param abc: Description. |
| 30 | + :param def: Description. |
| 31 | +
|
| 32 | + :return xyz: Description. |
| 33 | + """ |
| 34 | +
|
| 35 | +For Python, write one-line docstrings on 3 lines. e.g. |
| 36 | + """ |
| 37 | + Description |
| 38 | + """ |
| 39 | +
|
| 40 | +For Python, prefer f-string formatting over other string formatting methods. |
| 41 | +
|
| 42 | +For Python and JS, always use type annotations for function parameters and return types. Create custom types for complex structures, especially for lists and dicts. |
| 43 | +
|
| 44 | +For JS, prefer functional React components with hooks over class components. |
| 45 | +For JS, use async-await syntax. |
| 46 | +For JS, use function declarations for named functions. Use arrow functions for callbacks and short, anonymous functions. |
| 47 | +For JS, write JSDoc docstrings. e.g. |
| 48 | + /** |
| 49 | + * Return the sum of abc and def. |
| 50 | + * |
| 51 | + * @param abc Description. |
| 52 | + * @param def Description. |
| 53 | + * |
| 54 | + * @returns xyz Description. |
| 55 | + */ |
| 56 | +
|
| 57 | +In Bash, use UPPER_SNAKE_CASE for all variables and lower_snake_case for functions. |
| 58 | +
|
| 59 | +For Markdown: |
| 60 | + Create lists using a dash instead of an asterisk. |
| 61 | + Style bold text as `**bold**`. |
| 62 | + Style italic text as `_italics_`. |
| 63 | +``` |
0 commit comments