You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+37-27Lines changed: 37 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,33 +5,43 @@ If there are conflicting or ambigious rules, mention them immediately in any ses
5
5
## Rules
6
6
7
7
1. Quality
8
-
- Clean code
9
-
- Proper error handling
10
-
- Documentation of functions and modules but not changes per prompt
11
8
12
-
2. Conventions
13
-
- Use consistent naming conventions for scripts and files
9
+
- Clean code
10
+
- Proper error handling
11
+
- Documentation of functions and modules but not changes per prompt
12
+
13
+
2. Conventions
14
+
15
+
- Use consistent naming conventions for scripts and files
14
16
15
17
3. Patterns
16
-
- Prevent recursive scripts from deleting important and unrelated files
17
-
- Protect against security issues
18
-
- Prevent infinite loops
19
-
- Avoid hardcoding values
20
-
- Ensure script performance
21
-
- Bail on malformed paths
22
-
23
-
3. Testing
24
-
- Add tests for any cli changes
25
-
- Test inputs and outputs
26
-
- Ensure full branching, statements, and path coverage
27
-
28
-
4. Files
29
-
- Always use .zsh extension for shell files
30
-
- Update the README.md if modifications/updates/changes are added to osa-cli tool scope which change/add/remove usage/description/args/options of the cli we need the cli doc to always match the actual implementation.
31
-
32
-
33
-
5. Prompting/Responses
34
-
- Do not create or generate or modify files documenting changes made in prompt.
35
-
- Do not add comments indicating changes were made in response to a prompt.
36
-
- Avoid mentioning the use of AI or Copilot in code comments or documentation.
37
-
- Write code that is understandable and legible for humans
18
+
19
+
- Prevent recursive scripts from deleting important and unrelated files
20
+
- Protect against security issues
21
+
- Prevent infinite loops
22
+
- Avoid hardcoding values
23
+
- Ensure script performance
24
+
- Bail on malformed paths
25
+
26
+
4. Testing
27
+
28
+
- Add tests for any cli changes
29
+
- Test inputs and outputs
30
+
- Ensure full branching, statements, and path coverage
31
+
32
+
5. Files
33
+
34
+
- Always use .zsh extension for shell files
35
+
- Update the README.md if modifications/updates/changes are added to osa-cli tool scope which change/add/remove usage/description/args/options of the cli we need the cli doc to always match the actual implementation.
36
+
37
+
6. Prompting/Responses
38
+
- Do not create or generate or modify files documenting changes made in prompt.
39
+
- Do not add comments indicating changes were made in response to a prompt.
40
+
- Avoid mentioning the use of AI or Copilot in code comments or documentation.
41
+
- Write code that is understandable and legible for humans
42
+
43
+
## Setup
44
+
45
+
- this repo uses yarn for commands related to javascript/typescript code
46
+
- this repo requires tests and coverage to be 100%.
0 commit comments